Class Pane

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

Inheritance
System.Object
Pane
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.Windows.Documents.Spreadsheet.Model
Assembly: Telerik.Windows.Documents.Spreadsheet.dll

Syntax

public class Pane

Constructors

Pane(CellIndex, Int32, Int32, ViewportPaneType, PaneState)

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

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

Index of the top left cell.
System.Int32 xSplit

The x split.
System.Int32 ySplit

The y split.
ViewportPaneType activePane

The active pane.
PaneState state

The state.

Properties

ActivePane

Gets which viewport pane has focus and receives user input.

Declaration
public ViewportPaneType ActivePane { get; }
Property Value
ViewportPaneType

The active pane.

State

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

Declaration
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
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
public int XSplit { get; }
Property Value
System.Int32

The X split.

YSplit

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

Declaration
public int YSplit { get; }
Property Value
System.Int32

The Y split.

Methods

Clone()

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

Declaration
public Pane Clone()
Returns
Pane

The result pane.

Equals(Object)

Determines whether the specified System.Object is equal to the current System.Object.

Declaration
public override bool Equals(object obj)
Parameters
System.Object obj

The object to compare with the current object.
Returns
System.Boolean

True if the specified System.Object is equal to the current System.Object; otherwise, false.
Overrides
System.Object.Equals(System.Object)

GetHashCode()

Serves as a hash function for a particular type.

Declaration
public override int GetHashCode()
Returns
System.Int32

A hash code for the current System.Object.
Overrides
System.Object.GetHashCode()