Class
SortConditionBase<T>

Abstract base for sort conditions that compare typed cell properties to determine row or column order.

Definition

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

Assembly:Telerik.Windows.Documents.Spreadsheet.dll

Type Parameters:

T

The type of the T.

Syntax:

cs-api-definition
public abstract class SortConditionBase<T> : ISortCondition

Inheritance: objectSortConditionBase<T>

Derived Classes: OrderedSortConditionBase<T>

Implements: ISortCondition

Constructors

SortConditionBase(int)

Initializes a new sort condition with the specified relative index within the sort range.

Declaration

cs-api-definition
protected SortConditionBase(int relativeIndex)

Parameters

relativeIndex

int

Gets the index of the row or column that is key for sorting relative to the sorted range.

Properties

Comparer

Gets the comparer that defines the ordering logic for this sort condition.

Declaration

cs-api-definition
public abstract IComparer<SortValue> Comparer { get; }

Property Value

IComparer<SortValue>

The comparer used for sorting.

Implements ISortCondition.Comparer

PropertyDefinition

Gets the cell property definition that determines which cell attribute is compared during sorting.

Declaration

cs-api-definition
protected abstract IPropertyDefinition<T> PropertyDefinition { get; }

Property Value

IPropertyDefinition<T>

The property definition of the property which is used for sorting.

RelativeIndex

Gets the zero-based offset within the sort range that identifies the row or column containing values to compare.

Declaration

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

Property Value

int

The index of the row or column that it key for sorting relative to the sorted range.

Implements ISortCondition.RelativeIndex

Methods

Equals(object)

Determines whether the specified sort condition has the same relative index.

Declaration

cs-api-definition
public override bool Equals(object obj)

Parameters

obj

object

The object to compare with the current object.

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

Overrides object.Equals(object)

GetHashCode()

Computes a hash code based on the relative index property.

Declaration

cs-api-definition
public override int GetHashCode()

Returns

int

A hash code for the current object.

Overrides object.GetHashCode()

GetValue(Cells, int, int)

Extracts the cell property value used for comparison, respecting cell styles and property inheritance.

Declaration

cs-api-definition
public virtual object GetValue(Cells cells, int rowIndex, int columnIndex)

Parameters

cells

Cells

The cells.

rowIndex

int

The row index.

columnIndex

int

The column index.

Returns

object

The value of the specified cell.

Implements ISortCondition.GetValue(Cells, int, int)