Class
CustomFilter

Filters rows by comparing cell values against one or two custom criteria using relational operators; use for range-based or multi-condition filtering.

Definition

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

Assembly:Telerik.Windows.Documents.Spreadsheet.dll

Syntax:

cs-api-definition

public class CustomFilter : CellValuesFilterBase, IFilter

Inheritance: objectFilterBase<ICellValue>CellValuesFilterBaseCustomFilter

Implements: IFilter

Inherited Members CellValuesFilterBase.PropertyDefinitionFilterBase<ICellValue>.GetValue(Cells, int, int)FilterBase<ICellValue>.RelativeColumnIndex

Constructors

CustomFilter(int, CustomFilterCriteria)

Initializes a new instance of the CustomFilter class.

Declaration

cs-api-definition

public CustomFilter(int relativeColumnIndex, CustomFilterCriteria criteria)

Parameters

relativeColumnIndex

int

Relative index of the column.

criteria

CustomFilterCriteria

The criteria.

CustomFilter(int, CustomFilterCriteria, LogicalOperator, CustomFilterCriteria)

Initializes a new instance of the CustomFilter class.

Declaration

cs-api-definition

public CustomFilter(int relativeColumnIndex, CustomFilterCriteria criteria1, LogicalOperator logicalOperator, CustomFilterCriteria criteria2)

Parameters

relativeColumnIndex

int

Relative index of the column.

criteria1

CustomFilterCriteria

The first criteria.

logicalOperator

LogicalOperator

The logical operator.

criteria2

CustomFilterCriteria

The second criteria.

Properties

Criteria1

Gets the first comparison criterion applied to filter cell values.

Declaration

cs-api-definition

public CustomFilterCriteria Criteria1 { get; }

Property Value

CustomFilterCriteria

The first criteria.

Criteria2

Gets the second comparison criterion, if specified. This is used together with Criteria1 and combined using the LogicalOperator; returns null if only one criterion is set.

Declaration

cs-api-definition

public CustomFilterCriteria Criteria2 { get; }

Property Value

CustomFilterCriteria

The second criteria.

LogicalOperator

Gets the logical operator (AND or OR) used to combine the two criteria when both are present.

Declaration

cs-api-definition

public LogicalOperator LogicalOperator { get; }

Property Value

LogicalOperator

The logical operator.

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 cell value passes the filter criteria and should be shown.

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<ICellValue>.ShouldShowValue(object)

ClassCustomFilter

Class
CustomFilter