Interface IFilter

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

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

Syntax

public interface IFilter

Properties

RelativeColumnIndex

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

Declaration
int RelativeColumnIndex { get; }
Property Value
System.Int32

The relative index of the column.

Methods

GetValue(Cells, Int32, Int32)

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

Declaration
object GetValue(Cells cells, int rowIndex, int columnIndex)
Parameters
Cells cells

The cells of the worksheet.
System.Int32 rowIndex

Index of the row.
System.Int32 columnIndex

Index of the column.
Returns
System.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
bool ShouldShowValue(object value)
Parameters
System.Object value

The value retrieved by the GetValue method.
Returns
System.Boolean

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

Extension Methods