Class SelectionState

Captures the current selection state in a worksheet, including selected cell ranges, active cell, viewport pane, and selected shapes.

Inheritance
System.Object
SelectionState
Inherited Members
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
Assembly: Telerik.Windows.Documents.Spreadsheet.dll

Syntax

public class SelectionState

Constructors

SelectionState(IEnumerable<CellRange>, CellIndex, ViewportPaneType)

Initializes a new SelectionState with the specified selected ranges, active cell, and viewport pane.

Declaration
public SelectionState(IEnumerable<CellRange> selectedRanges, CellIndex activeCellIndex, ViewportPaneType pane)
Parameters
System.Collections.Generic.IEnumerable<CellRange> selectedRanges

The selected ranges.
CellIndex activeCellIndex

Index of the active cell.
ViewportPaneType pane

The pane.

Properties

ActiveCellIndex

Gets the index of the active cell, which receives keyboard input and is the focus point for selection operations.

Declaration
public CellIndex ActiveCellIndex { get; }
Property Value
CellIndex

The index of the active cell.

Pane

Gets the viewport pane where the selection is located, relevant when the worksheet has frozen panes.

Declaration
public ViewportPaneType Pane { get; }
Property Value
ViewportPaneType

The pane.

SelectedRanges

Gets the collection of cell ranges currently selected in the worksheet.

Declaration
public IEnumerable<CellRange> SelectedRanges { get; }
Property Value
System.Collections.Generic.IEnumerable<CellRange>

The selected ranges.

Methods

Clone()

Creates a deep copy of this selection state.

Declaration
public SelectionState Clone()
Returns
SelectionState

The cloned selection state.

ToString()

Returns a string representation of this selection state, including pane, active cell, and selected ranges.

Declaration
public override string ToString()
Returns
System.String

A System.String that represents the current System.Object.
Overrides
System.Object.ToString()

Extension Methods