Class
DynamicFilter

Filters rows based on dynamic date/time criteria (e.g., Today, This Month, Last Year) or numeric criteria (Above/Below Average); recalculates on each evaluation.

Definition

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

Assembly:Telerik.Windows.Documents.Spreadsheet.dll

Syntax:

cs-api-definition

public class DynamicFilter : CellValuesFilterBase, IFilter

Inheritance: objectFilterBase<ICellValue>CellValuesFilterBaseDynamicFilter

Implements: IFilter

Inherited Members CellValuesFilterBase.PropertyDefinitionFilterBase<ICellValue>.RelativeColumnIndex

Constructors

DynamicFilter(int, DynamicFilterType)

Initializes a new instance of the DynamicFilter class.

Declaration

cs-api-definition

public DynamicFilter(int relativeColumnIndex, DynamicFilterType dynamicFilterType)

Parameters

relativeColumnIndex

int

Relative index of the column.

dynamicFilterType

DynamicFilterType

Type of the dynamic filter.

Properties

DynamicFilterType

Gets the dynamic filter criterion (date-relative, time period, or average comparison) applied to cell values.

Declaration

cs-api-definition

public DynamicFilterType DynamicFilterType { get; }

Property Value

DynamicFilterType

The type of the dynamic filter.

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()

GetValue(Cells, int, int)

Retrieves the cell value at the specified row and column, interpreting numeric values as dates when formatted as such.

Declaration

cs-api-definition

public override 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.

Overrides FilterBase<ICellValue>.GetValue(Cells, int, int)

ShouldShowValue(object)

Determines whether the row containing the specified date or numeric value satisfies the dynamic filter criterion.

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)

ClassDynamicFilter

Class
DynamicFilter