Class
Pane

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

Definition

Namespace:Telerik.Windows.Documents.Spreadsheet.Model

Assembly:Telerik.Windows.Documents.Spreadsheet.dll

Syntax:

cs-api-definition

public class Pane

Inheritance: objectPane

Constructors

Pane(CellIndex, int, int, ViewportPaneType, PaneState)

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

Declaration

cs-api-definition

public Pane(CellIndex topLeftCellIndex, int xSplit, int ySplit, ViewportPaneType activePane, PaneState state = PaneState.Frozen)

Parameters

topLeftCellIndex

CellIndex

Index of the top left cell.

xSplit

int

The x split.

ySplit

int

The y split.

activePane

ViewportPaneType

The active pane.

state

PaneState

The state.

Properties

ActivePane

Gets which viewport pane has focus and receives user input.

Declaration

cs-api-definition

public ViewportPaneType ActivePane { get; }

Property Value

ViewportPaneType

The active pane.

State

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

Declaration

cs-api-definition

public PaneState State { get; }

Property Value

PaneState

The state.

TopLeftCellIndex

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

Declaration

cs-api-definition

public CellIndex TopLeftCellIndex { get; }

Property Value

CellIndex

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

XSplit

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

Declaration

cs-api-definition

public int XSplit { get; }

Property Value

int

The X split.

YSplit

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

Declaration

cs-api-definition

public int YSplit { get; }

Property Value

int

The Y split.

Methods

Clone()

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

Declaration

cs-api-definition

public Pane Clone()

Returns

Pane

The result pane.

Equals(object)

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

Declaration

cs-api-definition

public override bool Equals(object obj)

Parameters

obj

object

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)

GetHashCode()

Serves as a hash function for a particular type.

Declaration

cs-api-definition

public override int GetHashCode()

Returns

int

A hash code for the current object.

Overrides object.GetHashCode()

ClassPane

Class
Pane