Class FilterBase<T>

Abstract base for filters that evaluate cell properties of type T to determine row visibility; provides property retrieval and copying behavior.

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

Syntax

public abstract class FilterBase<T> : IFilter, ITranslatable, ICopyable<IFilter>
Type Parameters
T

The type of the property definition of the filter.

Constructors

FilterBase(Int32)

Initializes a new instance of the FilterBase<T> class.

Declaration
protected FilterBase(int relativeColumnIndex)
Parameters
System.Int32 relativeColumnIndex

Index of the relative column.

Properties

PropertyDefinition

Gets the cell property definition specifying which property to retrieve for filter evaluation.

Declaration
protected abstract IPropertyDefinition<T> PropertyDefinition { get; }
Property Value
IPropertyDefinition<T>

The property definition.

RelativeColumnIndex

Gets the zero-based column offset within the filter range to which this filter applies.

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

The relative index of the column.
Implements

Methods

GetValue(Cells, Int32, Int32)

Retrieves the property value from the cell at the specified row and column, respecting style inheritance.

Declaration
public virtual 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.
Implements

ShouldShowValue(Object)

Evaluates whether the row containing the specified property value passes the filter criterion and should be visible.

Declaration
public abstract 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
Implements

Extension Methods