Class FillColorSortCondition

Sort condition that orders cells by their background fill color, grouping matching fills together.

Inheritance
System.Object
SortConditionBase<IFill>
OrderedSortConditionBase<IFill>
FillColorSortCondition
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.Windows.Documents.Spreadsheet.Model.Sorting
Assembly: Telerik.Windows.Documents.Spreadsheet.dll

Syntax

public sealed class FillColorSortCondition : OrderedSortConditionBase<IFill>, ISortCondition, ITranslatable, ICopyable<ISortCondition>, IWorksheetSortCondition

Constructors

FillColorSortCondition(Int32, IFill, SortOrder)

Initializes a new instance of the FillColorSortCondition class with a target fill color for sorting.

Declaration
public FillColorSortCondition(int relativeIndex, IFill fill, SortOrder sortOrder)
Parameters
System.Int32 relativeIndex

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

The fill.
SortOrder sortOrder

The sort order.

Properties

Comparer

Gets the comparer that prioritizes cells matching the target fill color.

Declaration
public override IComparer<SortValue> Comparer { get; }
Property Value
System.Collections.Generic.IComparer<SortValue>

The comparer used for sorting.
Overrides
Telerik.Windows.Documents.Spreadsheet.Model.Sorting.SortConditionBase<Telerik.Windows.Documents.Spreadsheet.Model.IFill>.Comparer

Fill

Gets the target fill color used to identify matching cells for priority sorting.

Declaration
public IFill Fill { get; }
Property Value
IFill

The fill.

PropertyDefinition

Gets the cell fill property definition used for color comparison.

Declaration
protected override IPropertyDefinition<IFill> PropertyDefinition { get; }
Property Value
IPropertyDefinition<IFill>

The property definition of the property which is used for sorting.
Overrides
Telerik.Windows.Documents.Spreadsheet.Model.Sorting.SortConditionBase<Telerik.Windows.Documents.Spreadsheet.Model.IFill>.PropertyDefinition

Methods

Equals(Object)

Determines whether the specified object is a FillColorSortCondition with the same fill color and settings.

Declaration
public override bool Equals(object obj)
Parameters
System.Object obj

The obj.
Returns
System.Boolean

Overrides
Telerik.Windows.Documents.Spreadsheet.Model.Sorting.OrderedSortConditionBase<Telerik.Windows.Documents.Spreadsheet.Model.IFill>.Equals(System.Object)

GetHashCode()

Computes a hash code combining the fill color and base sort condition hash.

Declaration
public override int GetHashCode()
Returns
System.Int32

Overrides
Telerik.Windows.Documents.Spreadsheet.Model.Sorting.OrderedSortConditionBase<Telerik.Windows.Documents.Spreadsheet.Model.IFill>.GetHashCode()

GetValue(Cells, Int32, Int32)

Extracts the fill color from the specified cell, resolving theme colors to local RGB values.

Declaration
public override object GetValue(Cells cells, int rowIndex, int columnIndex)
Parameters
Cells cells

The cells.
System.Int32 rowIndex

The row index.
System.Int32 columnIndex

The column index.
Returns
System.Object

The value of the specified cell.
Overrides
Telerik.Windows.Documents.Spreadsheet.Model.Sorting.SortConditionBase<Telerik.Windows.Documents.Spreadsheet.Model.IFill>.GetValue(Telerik.Windows.Documents.Spreadsheet.Model.Cells, System.Int32, System.Int32)

Extension Methods