Class
FillColorFilter

Filters rows by matching cell background fill color against a specified fill; use for visual grouping in filtered data.

Definition

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

Assembly:Telerik.Windows.Documents.Spreadsheet.dll

Syntax:

cs-api-definition

public class FillColorFilter : FilterBase<IFill>, IFilter

Inheritance: objectFilterBase<IFill>FillColorFilter

Implements: IFilter

Inherited Members FilterBase<IFill>.GetValue(Cells, int, int)FilterBase<IFill>.RelativeColumnIndex

Constructors

FillColorFilter(int, IFill)

Initializes a new instance of the FillColorFilter class.

Declaration

cs-api-definition

public FillColorFilter(int relativeColumnIndex, IFill fill)

Parameters

relativeColumnIndex

int

Relative index of the column.

fill

IFill

The fill.

Properties

Fill

Gets the target background fill that cells must match to pass the filter.

Declaration

cs-api-definition

public IFill Fill { get; }

Property Value

IFill

The fill.

PropertyDefinition

Gets the cell fill property definition used to retrieve fill values from cells.

Declaration

cs-api-definition

protected override IPropertyDefinition<IFill> PropertyDefinition { get; }

Property Value

IPropertyDefinition<IFill>

The property definition.

Overrides FilterBase<IFill>.PropertyDefinition

Methods

Equals(object)

Determines whether the specified object is equal to the current object.

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

Serves as a hash function for a particular type.

Declaration

cs-api-definition

public override int GetHashCode()

Returns

int

A hash code for the current object.

Overrides object.GetHashCode()

ShouldShowValue(object)

Determines whether the row containing the specified fill matches the filter's target fill, accounting for theme color resolution.

Declaration

cs-api-definition

public override bool ShouldShowValue(object value)

Parameters

value

object

The value retrieved by the GetValue method.

Returns

bool

A value indicating whether the row which contains the specified value will be shown

Overrides FilterBase<IFill>.ShouldShowValue(object)

ClassFillColorFilter

Class
FillColorFilter