Back to all docs
API Reference / Telerik.Windows.Documents.Spreadsheet.Model.Printing / PageBreaks
New to Telerik Document Processing? Start a free 30-day trial

PageBreaks

Class

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

Inheritance: objectPageBreaks

Methods

Clear()

Removes all horizontal and vertical page breaks from the worksheet.

C#
public void Clear()

TryInsertHorizontalPageBreak(int, int)

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

C#
public bool TryInsertHorizontalPageBreak(int rowIndex, int columnIndex)
Parameters:rowIndexint

Index of the row.

columnIndexint

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.

C#
public bool TryInsertPageBreaks(int rowIndex, int columnIndex)
Parameters:rowIndexint

Index of the row.

columnIndexint

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.

C#
public bool TryInsertVerticalPageBreak(int rowIndex, int columnIndex)
Parameters:rowIndexint

Index of the row.

columnIndexint

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.

C#
public bool TryRemoveHorizontalPageBreak(int rowIndex, int columnIndex)
Parameters:rowIndexint

Index of the row.

columnIndexint

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.

C#
public bool TryRemovePageBreaks(int rowIndex, int columnIndex)
Parameters:rowIndexint

Index of the row.

columnIndexint

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.

C#
public bool TryRemoveVerticalPageBreak(int rowIndex, int columnIndex)
Parameters:rowIndexint

Index of the row.

columnIndexint

Index of the column.

Returns:

bool

True if succeeded.

Properties

HorizontalPageBreaks

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

C#
public IEnumerable<PageBreak> HorizontalPageBreaks { get; }
Property Value:

The horizontal page breaks.

VerticalPageBreaks

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

C#
public IEnumerable<PageBreak> VerticalPageBreaks { get; }
Property Value:

The vertical page breaks.

In this article
DefinitionMethodsClear()TryInsertHorizontalPageBreak(int, int)TryInsertPageBreaks(int, int)TryInsertVerticalPageBreak(int, int)TryRemoveHorizontalPageBreak(int, int)TryRemovePageBreaks(int, int)TryRemoveVerticalPageBreak(int, int)PropertiesHorizontalPageBreaksVerticalPageBreaks
Not finding the help you need?
Contact Support