Class
ForeColorFilter

Filters rows by matching cell text (foreground) color against a specified color; 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 ForeColorFilter : FilterBase<ThemableColor>, IFilter

Inheritance: objectFilterBase<ThemableColor>ForeColorFilter

Implements: IFilter

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

Constructors

ForeColorFilter(int, ThemableColor)

Initializes a new instance of the ForeColorFilter class.

Declaration

cs-api-definition

public ForeColorFilter(int relativeColumnIndex, ThemableColor color)

Parameters

relativeColumnIndex

int

Index of the relative column.

color

ThemableColor

The color.

Properties

Color

Gets the target text color that cells must match to pass the filter.

Declaration

cs-api-definition

public ThemableColor Color { get; }

Property Value

ThemableColor

The fore color.

PropertyDefinition

Gets the cell fore color property definition used to retrieve text color values from cells.

Declaration

cs-api-definition

protected override IPropertyDefinition<ThemableColor> PropertyDefinition { get; }

Property Value

IPropertyDefinition<ThemableColor>

The property definition.

Overrides FilterBase<ThemableColor>.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 text color matches the filter's target color, 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<ThemableColor>.ShouldShowValue(object)

ClassForeColorFilter

Class
ForeColorFilter