Class SelectionBase

Represents a base class for the different types of selections.

Inheritance
System.Object
SelectionBase
Selection
Namespace: Telerik.Windows.Controls.Spreadsheet.Worksheets
Assembly: Telerik.Windows.Controls.Spreadsheet.dll

Syntax

public abstract class SelectionBase : Object

Properties

ActiveRange

Gets the active range.

Declaration
public SelectionRange ActiveRange { get; }
Property Value
SelectionRange

The active range.

Cells

Gets the cells selection.

Declaration
public CellSelection Cells { get; }
Property Value
Telerik.Windows.Documents.Spreadsheet.Model.CellSelection

The cells selection.

Columns

Gets the columns selection.

Declaration
public ColumnSelection Columns { get; }
Property Value
Telerik.Windows.Documents.Spreadsheet.Model.ColumnSelection

The columns selection.

IsColumnSelection

Gets the value defining if the selection is column selection.

Declaration
public bool IsColumnSelection { get; }
Property Value
System.Boolean

The value defining if the selection is column selection.

IsRowSelection

Gets the value defining if the selection is row selection.

Declaration
public bool IsRowSelection { get; }
Property Value
System.Boolean

The value defining if the selection is row selection.

IsSelectionInProgress

Gets the value indicating if the selection is in progress.

Declaration
public bool IsSelectionInProgress { get; }
Property Value
System.Boolean

The value indicating if the selection is in progress.

Rows

Gets the rows selection.

Declaration
public RowSelection Rows { get; }
Property Value
Telerik.Windows.Documents.Spreadsheet.Model.RowSelection

The rows selection.

SelectedRanges

Gets the selected ranges.

Declaration
public virtual IEnumerable<CellRange> SelectedRanges { get; }
Property Value
System.Collections.Generic.IEnumerable<Telerik.Windows.Documents.Spreadsheet.Model.CellRange>

The selected ranges.

SelectedRangesCount

Gets the selected ranges count.

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

The selected ranges count.

Methods

BeginUpdate()

Begins the update.

Declaration
public void BeginUpdate()

ContainsColumn(Int32)

Determines whether the selection contains column.

Declaration
public bool ContainsColumn(int columnIndex)
Parameters
System.Int32 columnIndex

Index of the column.
Returns
System.Boolean

True if contains the column.

ContainsIndex(CellIndex)

Determines whether the selection contains cell index.

Declaration
public bool ContainsIndex(CellIndex cellIndex)
Parameters
Telerik.Windows.Documents.Spreadsheet.Model.CellIndex cellIndex

Index of the cell.
Returns
System.Boolean

True if contains the cell index.

ContainsPosition(CellPosition)

Determines whether the selection contains cell position.

Declaration
public bool ContainsPosition(CellPosition cellPosition)
Parameters
CellPosition cellPosition

The cell position.
Returns
System.Boolean

True if contains the position.

ContainsRange(CellRange)

Determines whether the selection contains cell range.

Declaration
public bool ContainsRange(CellRange cellRange)
Parameters
Telerik.Windows.Documents.Spreadsheet.Model.CellRange cellRange

The cell range.
Returns
System.Boolean

True if contains the range.

ContainsRow(Int32)

Determines whether the selection contains row.

Declaration
public bool ContainsRow(int rowIndex)
Parameters
System.Int32 rowIndex

Index of the row.
Returns
System.Boolean

True if contains the row.

EndUpdate()

Ends the update.

Declaration
public void EndUpdate()

IntersectsColumn(Int32)

Checks if the the column intersects with the selection.

Declaration
public virtual bool IntersectsColumn(int columnIndex)
Parameters
System.Int32 columnIndex

Index of the column.
Returns
System.Boolean

True if intersects.

IntersectsRow(Int32)

Checks if the the row intersects with the selection.

Declaration
public virtual bool IntersectsRow(int rowIndex)
Parameters
System.Int32 rowIndex

Index of the row.
Returns
System.Boolean

True if intersects.

OnSelectionChanged()

Called when the selection is changed.

Declaration
protected virtual void OnSelectionChanged()

OnSelectionChanging(SelectionChangingEventArgs)

Raises the SelectionChanging event.

Declaration
protected virtual void OnSelectionChanging(SelectionChangingEventArgs args)
Parameters
SelectionChangingEventArgs args

The SelectionChangingEventArgs instance containing the event data.

OnSelectionChangingCanceled()

Called when the selection changing is canceled.

Declaration
protected virtual void OnSelectionChangingCanceled()

OnSelectionUpdate()

Called on selection update.

Declaration
protected virtual void OnSelectionUpdate()

Select(Int32, Int32, Int32, Int32, Boolean)

Selects the specified cell range.

Declaration
public void Select(int fromRowIndex, int fromColumnIndex, int toRowIndex, int toColumnIndex, bool clearSelection = true)
Parameters
System.Int32 fromRowIndex

From row index.
System.Int32 fromColumnIndex

From column index.
System.Int32 toRowIndex

To row index.
System.Int32 toColumnIndex

To column index.
System.Boolean clearSelection

Defines if the old selection has to be cleared.

Select(CellIndex, Boolean)

Selects the specified cell index.

Declaration
public void Select(CellIndex cellIndex, bool clearSelection = true)
Parameters
Telerik.Windows.Documents.Spreadsheet.Model.CellIndex cellIndex

Index of the cell.
System.Boolean clearSelection

Defines if the old selection has to be cleared.

Select(CellIndex, CellIndex, Boolean)

Selects range defined by the fromIndex and toIndex parameters.

Declaration
public void Select(CellIndex fromIndex, CellIndex toIndex, bool clearSelection = true)
Parameters
Telerik.Windows.Documents.Spreadsheet.Model.CellIndex fromIndex

From index of the range.
Telerik.Windows.Documents.Spreadsheet.Model.CellIndex toIndex

To index of the range.
System.Boolean clearSelection

Defines if the old selection has to be cleared.

Select(CellRange, Boolean)

Selects the specified cell range.

Declaration
public void Select(CellRange cellRange, bool clearSelection = true)
Parameters
Telerik.Windows.Documents.Spreadsheet.Model.CellRange cellRange

The cell range.
System.Boolean clearSelection

Defines if the old selection has to be cleared.

SelectAll()

Selects all.

Declaration
public void SelectAll()

Events

SelectionChanged

Occurs when the selection is changed.

Declaration
public event EventHandler SelectionChanged
Event Type
System.EventHandler

SelectionChanging

Occurs when the selection is changing.

Declaration
public event EventHandler<SelectionChangingEventArgs> SelectionChanging
Event Type
System.EventHandler<SelectionChangingEventArgs>

SelectionChangingCanceled

Occurs when the selection changing is canceled.

Declaration
public event EventHandler SelectionChangingCanceled
Event Type
System.EventHandler

SelectionUpdate

Occurs on selection update.

Declaration
public event EventHandler SelectionUpdate
Event Type
System.EventHandler

Extension Methods