Class PrintArea

Manages the collection of cell ranges to be printed, allowing multiple non-contiguous areas to be specified for printing.

Inheritance

System.Object

CellRangeInsertedOrRemovedAwareCollectionBase

CellRangeInsertedOrRemovedAwareOrderedCollection

PrintArea

Inherited Members

CellRangeInsertedOrRemovedAwareOrderedCollection.TranslateRange(CellRange, CellRange)

CellRangeInsertedOrRemovedAwareOrderedCollection.RangesList

CellRangeInsertedOrRemovedAwareOrderedCollection.CellRanges

CellRangeInsertedOrRemovedAwareCollectionBase.CanInsertOrRemove(ShiftType, CellRange, CellRange)

CellRangeInsertedOrRemovedAwareCollectionBase.ShouldTranslateUpDown(RangeType)

CellRangeInsertedOrRemovedAwareCollectionBase.ShouldTranslateLeftRight(RangeType)

CellRangeInsertedOrRemovedAwareCollectionBase.TranslateRanges(Dictionary<CellRange, CellRange>)

CellRangeInsertedOrRemovedAwareCollectionBase.Cells

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Telerik.Windows.Documents.Spreadsheet.Model.Printing

Assembly: Telerik.Windows.Documents.Spreadsheet.dll

Syntax

public class PrintArea : CellRangeInsertedOrRemovedAwareOrderedCollection

Properties

HasPrintAreaRanges

Gets whether any print area ranges have been defined, indicating that only specific areas will be printed.

Declaration

public bool HasPrintAreaRanges { get; }

Property Value

System.Boolean The value indicating whether there are print ranges.

Ranges

Gets the cell ranges currently configured for printing.

Declaration

public IEnumerable<CellRange> Ranges { get; }

Property Value

System.Collections.Generic.IEnumerable<CellRange> The ranges to print.

Methods

CanAddToPrintArea(IEnumerable<CellRange>)

Determines whether the specified ranges can be added without intersecting with existing print ranges.

Declaration

public bool CanAddToPrintArea(IEnumerable<CellRange> ranges)

Parameters

System.Collections.Generic.IEnumerable<CellRange> ranges The ranges.

Returns

System.Boolean The value indicating wheter the specified ranges can be added.

CanAddToPrintArea(CellRange)

Determines whether the specified range can be added without intersecting with existing print ranges.

Declaration

public bool CanAddToPrintArea(CellRange range)

Parameters

CellRange range The range.

Returns

System.Boolean The value indicating wheter the specified range can be added.

Clear()

Removes all print area ranges, reverting to printing the entire used worksheet area.

Declaration

public void Clear()

Insert(Int32, CellRange)

Inserts the specified index.

Declaration

protected override void Insert(int index, CellRange range)

Parameters

System.Int32 index The index.

CellRange range The range.

Overrides

CellRangeInsertedOrRemovedAwareOrderedCollection.Insert(Int32, CellRange)

OnAfterTranslation(Dictionary<CellRange, CellRange>, CellRange, ShiftType)

Called after translation.

Declaration

protected override void OnAfterTranslation(Dictionary<CellRange, CellRange> oldAndNewTranslatedRangesPositions, CellRange rangeToInsertOrRemove, ShiftType shiftType)

Parameters

System.Collections.Generic.Dictionary<CellRange, CellRange> oldAndNewTranslatedRangesPositions The old and new translated ranges positions.

CellRange rangeToInsertOrRemove The range to insert or remove.

ShiftType shiftType Type of the shift.

Overrides

CellRangeInsertedOrRemovedAwareCollectionBase.OnAfterTranslation(Dictionary<CellRange, CellRange>, CellRange, ShiftType)

OnBeforeTranslation(Dictionary<CellRange, CellRange>, CellRange, ShiftType)

Called before translation.

Declaration

protected override void OnBeforeTranslation(Dictionary<CellRange, CellRange> oldAndNewTranslatedRangesPositions, CellRange rangeToInsertOrRemove, ShiftType shiftType)

Parameters

System.Collections.Generic.Dictionary<CellRange, CellRange> oldAndNewTranslatedRangesPositions The old and new translated ranges positions.

CellRange rangeToInsertOrRemove The range to insert or remove.

ShiftType shiftType Type of the shift.

Overrides

CellRangeInsertedOrRemovedAwareCollectionBase.OnBeforeTranslation(Dictionary<CellRange, CellRange>, CellRange, ShiftType)

RemoveCellRangeAt(Int32)

Removes the cell range at.

Declaration

protected override void RemoveCellRangeAt(int index)

Parameters

System.Int32 index The index.

Overrides

CellRangeInsertedOrRemovedAwareOrderedCollection.RemoveCellRangeAt(Int32)

SetPrintArea(IEnumerable<CellRange>)

Replaces all existing print ranges with the specified collection of ranges.

Declaration

public void SetPrintArea(IEnumerable<CellRange> ranges)

Parameters

System.Collections.Generic.IEnumerable<CellRange> ranges The ranges.

SetPrintArea(CellRange)

Replaces all existing print ranges with a single specified range.

Declaration

public void SetPrintArea(CellRange range)

Parameters

CellRange range The range.

TryAddToPrintArea(IEnumerable<CellRange>)

Attempts to add multiple ranges to the print area if they do not intersect with existing ranges, and returns whether the operation succeeded.

Declaration

public bool TryAddToPrintArea(IEnumerable<CellRange> ranges)

Parameters

System.Collections.Generic.IEnumerable<CellRange> ranges The ranges.

Returns

System.Boolean

TryAddToPrintArea(CellRange)

Attempts to add a range to the print area if it does not intersect with existing ranges, and returns whether the operation succeeded.

Declaration

public bool TryAddToPrintArea(CellRange range)

Parameters

CellRange range The range.

Returns

System.Boolean

Extension Methods

SvgExtentions.Traverse<T>(T, Func<T, IEnumerable<T>>)

SvgExtentions.TraverseDepthFirst<T>(T, Func<T, IEnumerable<T>>)