New to Telerik Document Processing? Start a free 30-day trial

Pane

Class

Defines a viewport pane configuration for worksheets with frozen or split rows and columns.

Definition

Namespace:Telerik.Documents.Spreadsheet.Model

Assembly:Telerik.Windows.Documents.Spreadsheet.dll

Syntax:

C#
public class Pane

Inheritance: objectPane

Constructors

Initializes a new Pane with specified split positions, active viewport, and freeze state.

C#
public Pane(CellIndex topLeftCellIndex, int xSplit, int ySplit, ViewportPaneType activePane, PaneState state = PaneState.Frozen)
Parameters:topLeftCellIndexCellIndex

Index of the top left cell.

xSplitint

The x split.

ySplitint

The y split.

activePaneViewportPaneType

The active pane.

statePaneState

The state.

Properties

Gets which viewport pane has focus and receives user input.

C#
public ViewportPaneType ActivePane { get; }
Property Value:

The active pane.

Gets whether the pane is frozen or split, controlling scrolling behavior.

C#
public PaneState State { get; }
Property Value:

The state.

Gets the cell index that appears at the top-left corner of the scrollable pane when rows or columns are frozen.

C#
public CellIndex TopLeftCellIndex { get; }
Property Value:

The index of the top left cell of the scrollable pane.

Gets the horizontal split position, representing the number of columns visible in the frozen or split pane.

C#
public int XSplit { get; }
Property Value:

The X split.

Gets the vertical split position, representing the number of rows visible in the frozen or split pane.

C#
public int YSplit { get; }
Property Value:

The Y split.

Methods

Creates a deep copy of this pane configuration with identical split and state settings.

C#
public Pane Clone()
Returns:

Pane

The result pane.

Determines whether the specified object is equal to the current object.

C#
public override bool Equals(object obj)
Parameters:objobject

The object to compare with the current object.

Returns:

bool

True if the specified object is equal to the current object; otherwise, false.

Overrides: object.Equals(object)

Serves as a hash function for a particular type.

C#
public override int GetHashCode()
Returns:

int

A hash code for the current object.

Overrides: object.GetHashCode()