New to Telerik Document Processing? Start a free 30-day trial

DynamicFilter

Class

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:

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.

public DynamicFilter(int relativeColumnIndex, DynamicFilterType dynamicFilterType)

Parameters:relativeColumnIndexint

Relative index of the column.

dynamicFilterTypeDynamicFilterType

Type of the dynamic filter.

Methods

Equals(object)

bool

Determines whether the specified object is equal to the current object.

public override bool Equals(object obj)

Parameters:objobject

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

int

Serves as a hash function for a particular type.

public override int GetHashCode()

Returns:

int

A hash code for the current object.

Overrides: object.GetHashCode()

GetValue(Cells, int, int)

object

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

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

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

ShouldShowValue(object)

bool

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

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

Overrides: FilterBase<ICellValue>.ShouldShowValue(object)

Properties

DynamicFilterType

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

public DynamicFilterType DynamicFilterType { get; }

Property Value:

The type of the dynamic filter.