Documentation

Class DynamicFilter

Describes a filter which hides or shows the cells based on a criteria specified by the filter type.

Inheritance
System.Object
FilterBase<ICellValue>
CellValuesFilterBase
DynamicFilter
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.Windows.Documents.Spreadsheet.Model.Filtering
Assembly: Telerik.Windows.Documents.Spreadsheet.dll

Syntax

public class DynamicFilter : CellValuesFilterBase, IFilter, ITranslatable, ICopyable<IFilter>, IWorksheetFilter, IRangeFilter

Constructors

DynamicFilter(Int32, DynamicFilterType)

Initializes a new instance of the DynamicFilter class.

Declaration
public DynamicFilter(int relativeColumnIndex, DynamicFilterType dynamicFilterType)
Parameters
System.Int32 relativeColumnIndex

Relative index of the column.
DynamicFilterType dynamicFilterType

Type of the dynamic filter.

Properties

DynamicFilterType

Gets the type of the dynamic filter.

Declaration
public DynamicFilterType DynamicFilterType { get; }
Property Value
DynamicFilterType

The type of the dynamic filter.

Methods

Equals(Object)

Determines whether the specified System.Object is equal to the current System.Object.

Declaration
public override bool Equals(object obj)
Parameters
System.Object obj

The System.Object to compare with the current System.Object.
Returns
System.Boolean

true if the specified System.Object is equal to the current System.Object; otherwise, false.
Overrides
System.Object.Equals(System.Object)

GetHashCode()

Serves as a hash function for a particular type.

Declaration
public override int GetHashCode()
Returns
System.Int32

A hash code for the current System.Object.
Overrides
System.Object.GetHashCode()

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
public override 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.
Overrides
Telerik.Windows.Documents.Spreadsheet.Model.Filtering.FilterBase<Telerik.Windows.Documents.Spreadsheet.Model.ICellValue>.GetValue(Telerik.Windows.Documents.Spreadsheet.Model.Cells, System.Int32, System.Int32)

ShouldShowValue(Object)

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

Declaration
public override 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
Overrides
Telerik.Windows.Documents.Spreadsheet.Model.Filtering.FilterBase<Telerik.Windows.Documents.Spreadsheet.Model.ICellValue>.ShouldShowValue(System.Object)

Extension Methods