Class
SortState

Manages the active sort configuration for a worksheet, including the sorted range and applied sort conditions.

Definition

Namespace:Telerik.Windows.Documents.Spreadsheet.Model.Sorting

Assembly:Telerik.Windows.Documents.Spreadsheet.dll

Syntax:

cs-api-definition
public class SortState

Inheritance: objectSortState

Properties

Count

Gets the number of sort conditions currently applied to the worksheet.

Declaration

cs-api-definition
public int Count { get; }

Property Value

int

The count.

SortConditions

Gets the collection of sort conditions that define how the range is sorted.

Declaration

cs-api-definition
public IEnumerable<ISortCondition> SortConditions { get; }

Property Value

IEnumerable<ISortCondition>

The sort conditions.

SortRange

Gets the cell range to which the sort conditions are applied.

Declaration

cs-api-definition
public CellRange SortRange { get; }

Property Value

CellRange

The sort range.

Methods

Clear()

Removes all sort conditions and clears the sorted range.

Declaration

cs-api-definition
public void Clear()

Set(CellRange, params ISortCondition[])

Applies the specified sort conditions to the given cell range and sorts the data.

Declaration

cs-api-definition
public void Set(CellRange sortRange, params ISortCondition[] sortConditions)

Parameters

sortRange

CellRange

The sort range.

sortConditions

ISortCondition[]

The sort conditions.