Class
PageBreaks

Manages the collection of horizontal and vertical page breaks for a worksheet, controlling pagination during printing.

Definition

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

Assembly:Telerik.Windows.Documents.Spreadsheet.dll

Syntax:

cs-api-definition
public class PageBreaks

Inheritance: objectPageBreaks

Properties

HorizontalPageBreaks

Gets all horizontal page breaks, which split pages at specific row boundaries.

Declaration

cs-api-definition
public IEnumerable<PageBreak> HorizontalPageBreaks { get; }

Property Value

IEnumerable<PageBreak>

The horizontal page breaks.

VerticalPageBreaks

Gets all vertical page breaks, which split pages at specific column boundaries.

Declaration

cs-api-definition
public IEnumerable<PageBreak> VerticalPageBreaks { get; }

Property Value

IEnumerable<PageBreak>

The vertical page breaks.

Methods

Clear()

Removes all horizontal and vertical page breaks from the worksheet.

Declaration

cs-api-definition
public void Clear()

TryInsertHorizontalPageBreak(int, int)

Attempts to insert a horizontal page break at the specified row, and returns whether the operation succeeded.

Declaration

cs-api-definition
public bool TryInsertHorizontalPageBreak(int rowIndex, int columnIndex)

Parameters

rowIndex

int

Index of the row.

columnIndex

int

Index of the column.

Returns

bool

True if succeeded.

TryInsertPageBreaks(int, int)

Attempts to insert both horizontal and vertical page breaks at the specified cell, and returns whether at least one break was added.

Declaration

cs-api-definition
public bool TryInsertPageBreaks(int rowIndex, int columnIndex)

Parameters

rowIndex

int

Index of the row.

columnIndex

int

Index of the column.

Returns

bool

True if succeeded.

TryInsertVerticalPageBreak(int, int)

Attempts to insert a vertical page break at the specified column, and returns whether the operation succeeded.

Declaration

cs-api-definition
public bool TryInsertVerticalPageBreak(int rowIndex, int columnIndex)

Parameters

rowIndex

int

Index of the row.

columnIndex

int

Index of the column.

Returns

bool

True if succeeded.

TryRemoveHorizontalPageBreak(int, int)

Attempts to remove the horizontal page break at the specified row, and returns whether the operation succeeded.

Declaration

cs-api-definition
public bool TryRemoveHorizontalPageBreak(int rowIndex, int columnIndex)

Parameters

rowIndex

int

Index of the row.

columnIndex

int

Index of the column.

Returns

bool

True if succeeded.

TryRemovePageBreaks(int, int)

Attempts to remove both horizontal and vertical page breaks at the specified cell, and returns whether at least one break was removed.

Declaration

cs-api-definition
public bool TryRemovePageBreaks(int rowIndex, int columnIndex)

Parameters

rowIndex

int

Index of the row.

columnIndex

int

Index of the column.

Returns

bool

True if succeeded.

TryRemoveVerticalPageBreak(int, int)

Attempts to remove the vertical page break at the specified column, and returns whether the operation succeeded.

Declaration

cs-api-definition
public bool TryRemoveVerticalPageBreak(int rowIndex, int columnIndex)

Parameters

rowIndex

int

Index of the row.

columnIndex

int

Index of the column.

Returns

bool

True if succeeded.