Interface IFilter

Defines the common behaviour of the filter classes.

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

Syntax

public interface IFilter

Properties

RelativeColumnIndex

Gets the index of the column to which the filter is applied. The index is relative to the beginning of the filter range.

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

The relative index of the column.

Methods

GetValue(Cells, Int32, Int32)

Gets the value of the cell at the specified index. This value is used to determine whether the row will be hidden by the filter.

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)

Determines whether the row which contains the specified value will be shown.

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