Back to all docs
API Reference / Telerik.Windows.Documents.Spreadsheet.Model.Printing / PrintArea
New to Telerik UI for WinForms? Start a free 30-day trial

PrintArea

Class

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:
C#
public class PrintArea : CellRangeInsertedOrRemovedAwareOrderedCollection

Inheritance: objectCellRangeInsertedOrRemovedAwareCollectionBaseCellRangeInsertedOrRemovedAwareOrderedCollectionPrintArea

Inherited Members CellRangeInsertedOrRemovedAwareOrderedCollection.TranslateRange(CellRange, CellRange)CellRangeInsertedOrRemovedAwareOrderedCollection.RangesListCellRangeInsertedOrRemovedAwareOrderedCollection.CellRangesCellRangeInsertedOrRemovedAwareCollectionBase.CanInsertOrRemove(ShiftType, CellRange, CellRange)CellRangeInsertedOrRemovedAwareCollectionBase.ShouldTranslateUpDown(RangeType)CellRangeInsertedOrRemovedAwareCollectionBase.ShouldTranslateLeftRight(RangeType)CellRangeInsertedOrRemovedAwareCollectionBase.TranslateRanges(Dictionary<CellRange, CellRange>)CellRangeInsertedOrRemovedAwareCollectionBase.Cells...

Properties

HasPrintAreaRanges

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

C#
public bool HasPrintAreaRanges { get; }
Property Value:

The value indicating whether there are print ranges.

Ranges

IEnumerable<CellRange>

Gets the cell ranges currently configured for printing.

C#
public IEnumerable<CellRange> Ranges { get; }
Property Value:

The ranges to print.

Methods

CanAddToPrintArea(CellRange)

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

C#
public bool CanAddToPrintArea(CellRange range)
Parameters:rangeCellRange

The range.

Returns:

bool

The value indicating wheter the specified range can be added.

CanAddToPrintArea(IEnumerable<CellRange>)

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

C#
public bool CanAddToPrintArea(IEnumerable<CellRange> ranges)
Parameters:rangesIEnumerable<CellRange>

The ranges.

Returns:

bool

The value indicating wheter the specified ranges can be added.

Clear()

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

C#
public void Clear()

Insert(int, CellRange)

Inserts the specified index.

C#
protected override void Insert(int index, CellRange range)
Parameters:indexint

The index.

rangeCellRange

The range.

Overrides: CellRangeInsertedOrRemovedAwareOrderedCollection.Insert(int, CellRange)

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

Called after translation.

C#
protected override void OnAfterTranslation(Dictionary<CellRange, CellRange> oldAndNewTranslatedRangesPositions, CellRange rangeToInsertOrRemove, ShiftType shiftType)
Parameters:oldAndNewTranslatedRangesPositionsDictionary<CellRange, CellRange>

The old and new translated ranges positions.

rangeToInsertOrRemoveCellRange

The range to insert or remove.

shiftTypeShiftType

Type of the shift.

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

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

Called before translation.

C#
protected override void OnBeforeTranslation(Dictionary<CellRange, CellRange> oldAndNewTranslatedRangesPositions, CellRange rangeToInsertOrRemove, ShiftType shiftType)
Parameters:oldAndNewTranslatedRangesPositionsDictionary<CellRange, CellRange>

The old and new translated ranges positions.

rangeToInsertOrRemoveCellRange

The range to insert or remove.

shiftTypeShiftType

Type of the shift.

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

RemoveCellRangeAt(int)

Removes the cell range at.

C#
protected override void RemoveCellRangeAt(int index)
Parameters:indexint

The index.

Overrides: CellRangeInsertedOrRemovedAwareOrderedCollection.RemoveCellRangeAt(int)

SetPrintArea(CellRange)

Replaces all existing print ranges with a single specified range.

C#
public void SetPrintArea(CellRange range)
Parameters:rangeCellRange

The range.

SetPrintArea(IEnumerable<CellRange>)

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

C#
public void SetPrintArea(IEnumerable<CellRange> ranges)
Parameters:rangesIEnumerable<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.

C#
public bool TryAddToPrintArea(CellRange range)
Parameters:rangeCellRange

The range.

Returns:

bool

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.

C#
public bool TryAddToPrintArea(IEnumerable<CellRange> ranges)
Parameters:rangesIEnumerable<CellRange>

The ranges.

Returns:

bool

In this article
DefinitionPropertiesHasPrintAreaRangesRangesMethodsCanAddToPrintArea(CellRange)CanAddToPrintArea(IEnumerable<CellRange>)Clear()Insert(int, CellRange)OnAfterTranslation(Dictionary<CellRange, CellRange>, CellRange, ShiftType)OnBeforeTranslation(Dictionary<CellRange, CellRange>, CellRange, ShiftType)RemoveCellRangeAt(int)SetPrintArea(CellRange)SetPrintArea(IEnumerable<CellRange>)TryAddToPrintArea(CellRange)TryAddToPrintArea(IEnumerable<CellRange>)
Not finding the help you need?
Contact Support