New to Telerik Document Processing? Start a free 30-day trial

SortConditionBase<T>

Class

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:

The type of the T.

Syntax:

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.

protected SortConditionBase(int relativeIndex)

Parameters:relativeIndexint

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

Methods

Equals(object)

bool

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

public override bool Equals(object obj)

Parameters:objobject

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()

int

Computes a hash code based on the relative index property.

public override int GetHashCode()

Returns:

int

A hash code for the current object.

Overrides: object.GetHashCode()

GetValue(Cells, int, int)

object

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

public virtual object GetValue(Cells cells, int rowIndex, int columnIndex)

Parameters:cellsCells

The cells.

rowIndexint

The row index.

columnIndexint

The column index.

Returns:

object

The value of the specified cell.

Implements: ISortCondition.GetValue(Cells, int, int)

Properties

Comparer

IComparer<SortValue>

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

public abstract IComparer<SortValue> Comparer { get; }

Property Value:

The comparer used for sorting.

Implements: ISortCondition.Comparer

PropertyDefinition

IPropertyDefinition<T>

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

protected abstract IPropertyDefinition<T> PropertyDefinition { get; }

Property Value:

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

RelativeIndex

int

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

public int RelativeIndex { get; }

Property Value:

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

Implements: ISortCondition.RelativeIndex