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

FillColorSortCondition

Class

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

Definition

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

Assembly:Telerik.Windows.Documents.Spreadsheet.dll

Syntax:

public sealed class FillColorSortCondition : OrderedSortConditionBase<IFill>, ISortCondition

Inheritance: objectSortConditionBase<IFill>OrderedSortConditionBase<IFill>FillColorSortCondition

Implements: ISortCondition

Inherited Members OrderedSortConditionBase<IFill>.SortOrderSortConditionBase<IFill>.RelativeIndex

Constructors

FillColorSortCondition(int, IFill, SortOrder)

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

public FillColorSortCondition(int relativeIndex, IFill fill, SortOrder sortOrder)

Parameters:relativeIndexint

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

fillIFill

The fill.

sortOrderSortOrder

The sort order.

Methods

Equals(object)

bool

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

public override bool Equals(object obj)

Parameters:objobject

The obj.

Returns:

bool

Overrides: OrderedSortConditionBase<IFill>.Equals(object)

GetHashCode()

int

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

public override int GetHashCode()

Returns:

int

Overrides: OrderedSortConditionBase<IFill>.GetHashCode()

GetValue(Cells, int, int)

object

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

public override 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.

Overrides: SortConditionBase<IFill>.GetValue(Cells, int, int)

Properties

Comparer

IComparer<SortValue>

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

public override IComparer<SortValue> Comparer { get; }

Property Value:

The comparer used for sorting.

Overrides: SortConditionBase<IFill>.Comparer

Fill

IFill

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

public IFill Fill { get; }

Property Value:

The fill.

PropertyDefinition

IPropertyDefinition<IFill>

Gets the cell fill property definition used for color comparison.

protected override IPropertyDefinition<IFill> PropertyDefinition { get; }

Property Value:

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

Overrides: SortConditionBase<IFill>.PropertyDefinition