ClassPrintArea
Manages the collection of cell ranges to be printed, allowing multiple non-contiguous areas to be specified for printing.
Definition
Namespace:Telerik.Windows.Documents.Spreadsheet.Model.Printing
Assembly:Telerik.Windows.Documents.Spreadsheet.dll
Syntax:
public class PrintArea : CellRangeInsertedOrRemovedAwareOrderedCollectionInheritance: objectCellRangeInsertedOrRemovedAwareCollectionBaseCellRangeInsertedOrRemovedAwareOrderedCollectionPrintArea
Inherited Members
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
The value indicating whether there are print ranges.
Methods
CanAddToPrintArea(CellRange)
Determines whether the specified range can be added without intersecting with existing print ranges.
CanAddToPrintArea(IEnumerable<CellRange>)
Determines whether the specified ranges can be added without intersecting with existing print ranges.
Clear()
Removes all print area ranges, reverting to printing the entire used worksheet area.
Declaration
public void Clear()Insert(int, CellRange)
Inserts the specified index.
OnAfterTranslation(Dictionary<CellRange, CellRange>, CellRange, ShiftType)
Called after translation.
Declaration
protected override void OnAfterTranslation(Dictionary<CellRange, CellRange> oldAndNewTranslatedRangesPositions, CellRange rangeToInsertOrRemove, ShiftType shiftType)Parameters
oldAndNewTranslatedRangesPositions
Dictionary<CellRange, CellRange>
The old and new translated ranges positions.
rangeToInsertOrRemove
The range to insert or remove.
shiftType
Type of the shift.
Overrides
OnBeforeTranslation(Dictionary<CellRange, CellRange>, CellRange, ShiftType)
Called before translation.
Declaration
protected override void OnBeforeTranslation(Dictionary<CellRange, CellRange> oldAndNewTranslatedRangesPositions, CellRange rangeToInsertOrRemove, ShiftType shiftType)Parameters
oldAndNewTranslatedRangesPositions
Dictionary<CellRange, CellRange>
The old and new translated ranges positions.
rangeToInsertOrRemove
The range to insert or remove.
shiftType
Type of the shift.
Overrides
RemoveCellRangeAt(int)
Removes the cell range at.
Declaration
protected override void RemoveCellRangeAt(int index)Parameters
index
The index.
Overrides
SetPrintArea(CellRange)
Replaces all existing print ranges with a single specified range.
Declaration
public void SetPrintArea(CellRange range)Parameters
range
The range.
SetPrintArea(IEnumerable<CellRange>)
Replaces all existing print ranges with the specified collection of ranges.
Declaration
public void SetPrintArea(IEnumerable<CellRange> ranges)Parameters
ranges
IEnumerable<CellRange>
The ranges.
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.
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.