New to Telerik UI for WinForms? Start a free 30-day trial

SelectionState

Class

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

Definition

Assembly:Telerik.Windows.Documents.Spreadsheet.dll

Syntax:

public class SelectionState

Inheritance: objectSelectionState

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

public SelectionState(IEnumerable<CellRange> selectedRanges, CellIndex activeCellIndex, ViewportPaneType pane)

Parameters:selectedRangesIEnumerable<CellRange>

The selected ranges.

activeCellIndexCellIndex

Index of the active cell.

The pane.

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

public CellIndex ActiveCellIndex { get; }

Property Value:

The index of the active cell.

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

public ViewportPaneType Pane { get; }

Property Value:

The pane.

IEnumerable<CellRange>

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

public IEnumerable<CellRange> SelectedRanges { get; }

Property Value:

The selected ranges.

Creates a deep copy of this selection state.

public SelectionState Clone()

Returns:

The cloned selection state.

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

public override string ToString()

Returns:

A string that represents the current object.

Overrides: object.ToString()