Class PageBreaks

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

Inheritance
System.Object
PageBreaks
Inherited Members
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 PageBreaks

Properties

HorizontalPageBreaks

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

Declaration
public IEnumerable<PageBreak> HorizontalPageBreaks { get; }
Property Value
System.Collections.Generic.IEnumerable<PageBreak>

The horizontal page breaks.

VerticalPageBreaks

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

Declaration
public IEnumerable<PageBreak> VerticalPageBreaks { get; }
Property Value
System.Collections.Generic.IEnumerable<PageBreak>

The vertical page breaks.

Methods

Clear()

Removes all horizontal and vertical page breaks from the worksheet.

Declaration
public void Clear()

TryInsertHorizontalPageBreak(Int32, Int32)

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

Declaration
public bool TryInsertHorizontalPageBreak(int rowIndex, int columnIndex)
Parameters
System.Int32 rowIndex

Index of the row.
System.Int32 columnIndex

Index of the column.
Returns
System.Boolean

True if succeeded.

TryInsertPageBreaks(Int32, Int32)

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

Declaration
public bool TryInsertPageBreaks(int rowIndex, int columnIndex)
Parameters
System.Int32 rowIndex

Index of the row.
System.Int32 columnIndex

Index of the column.
Returns
System.Boolean

True if succeeded.

TryInsertVerticalPageBreak(Int32, Int32)

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

Declaration
public bool TryInsertVerticalPageBreak(int rowIndex, int columnIndex)
Parameters
System.Int32 rowIndex

Index of the row.
System.Int32 columnIndex

Index of the column.
Returns
System.Boolean

True if succeeded.

TryRemoveHorizontalPageBreak(Int32, Int32)

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

Declaration
public bool TryRemoveHorizontalPageBreak(int rowIndex, int columnIndex)
Parameters
System.Int32 rowIndex

Index of the row.
System.Int32 columnIndex

Index of the column.
Returns
System.Boolean

True if succeeded.

TryRemovePageBreaks(Int32, Int32)

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

Declaration
public bool TryRemovePageBreaks(int rowIndex, int columnIndex)
Parameters
System.Int32 rowIndex

Index of the row.
System.Int32 columnIndex

Index of the column.
Returns
System.Boolean

True if succeeded.

TryRemoveVerticalPageBreak(Int32, Int32)

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

Declaration
public bool TryRemoveVerticalPageBreak(int rowIndex, int columnIndex)
Parameters
System.Int32 rowIndex

Index of the row.
System.Int32 columnIndex

Index of the column.
Returns
System.Boolean

True if succeeded.