Interface
IFilter

Common contract for filters that control row visibility in AutoFilter ranges by evaluating cell values.

Definition

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

Assembly:Telerik.Windows.Documents.Spreadsheet.dll

Syntax:

cs-api-definition
public interface IFilter

Derived Classes: CellValuesFilterBaseCustomFilterDynamicFilterFillColorFilterFilterBase<T>ForeColorFilterTopFilterValuesCollectionFilter

Properties

RelativeColumnIndex

Column index within the filter range where this filter applies, zero-based relative to the first column of the filter range.

Declaration

cs-api-definition
int RelativeColumnIndex { get; }

Property Value

int

The relative index of the column.

Methods

GetValue(Cells, int, int)

Retrieves the cell value at the specified position, transforming it as needed for filter evaluation.

Declaration

cs-api-definition
object GetValue(Cells cells, int rowIndex, int columnIndex)

Parameters

cells

Cells

The cells of the worksheet.

rowIndex

int

Index of the row.

columnIndex

int

Index of the column.

Returns

object

The value of the cell.

ShouldShowValue(object)

Evaluates whether the row containing the specified value should remain visible based on the filter criteria.

Declaration

cs-api-definition
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