ClassCustomValuesSortCondition
Sort condition that orders cell values according to a custom list sequence, placing matching items first.
Definition
Namespace:Telerik.Windows.Documents.Spreadsheet.Model.Sorting
Assembly:Telerik.Windows.Documents.Spreadsheet.dll
Syntax:
public sealed class CustomValuesSortCondition : OrderedSortConditionBase<ICellValue>, ISortCondition
Inheritance: objectSortConditionBase<ICellValue>OrderedSortConditionBase<ICellValue>CustomValuesSortCondition
Implements:
Inherited Members
Constructors
CustomValuesSortCondition(int, string[], SortOrder)
Initializes a new instance of the CustomValuesSortCondition class with a custom list defining the sort order.
Declaration
public CustomValuesSortCondition(int relativeIndex, string[] customList, SortOrder sortOrder)
Parameters
relativeIndex
Gets the index of the row or column that is key for sorting relative to the sorted range.
customList
string[]
The custom list.
sortOrder
The sort order.
Properties
Comparer
Gets the comparer that ranks values by their position in the custom list.
Declaration
public override IComparer<SortValue> Comparer { get; }
Property Value
IComparer<SortValue>
The comparer used for sorting.
Overrides
CustomList
Gets the ordered array of strings defining the custom sort sequence.
Declaration
public string[] CustomList { get; }
Property Value
string[]
The custom list.
PropertyDefinition
Gets the cell value property definition used for custom list comparison.
Declaration
protected override IPropertyDefinition<ICellValue> PropertyDefinition { get; }
Property Value
IPropertyDefinition<ICellValue>
The property definition of the property which is used for sorting.
Overrides
Methods
Equals(object)
Determines whether the specified object is a CustomValuesSortCondition with the same custom list and settings.
GetHashCode()
Computes a hash code combining the base sort condition hash and the custom list content.