New to Telerik Document ProcessingStart a free 30-day trial

IFilter

Interface

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:

C#
public interface IFilter

Derived Classes: CellValuesFilterBaseCustomFilterDynamicFilterFillColorFilterFilterBase<T>ForeColorFilterTopFilterValuesCollectionFilter...

Methods

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

C#
object GetValue(Cells cells, int rowIndex, int columnIndex)
Parameters:cellsCells

The cells of the worksheet.

rowIndexint

Index of the row.

columnIndexint

Index of the column.

Returns:

object

The value of the cell.

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

C#
bool ShouldShowValue(object value)
Parameters:valueobject

The value retrieved by the GetValue method.

Returns:

bool

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

Properties

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

C#
int RelativeColumnIndex { get; }
Property Value:

The relative index of the column.