Documentation

Class CustomFilter

Describes a filter which compares the cell value to one or two critera in order to determine whether it should be shown.

Inheritance
System.Object
FilterBase<ICellValue>
CellValuesFilterBase
CustomFilter
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 CustomFilter : CellValuesFilterBase, IFilter, ITranslatable, ICopyable<IFilter>

Constructors

CustomFilter(Int32, CustomFilterCriteria)

Initializes a new instance of the CustomFilter class.

Declaration
public CustomFilter(int relativeColumnIndex, CustomFilterCriteria criteria)
Parameters
System.Int32 relativeColumnIndex

Relative index of the column.
CustomFilterCriteria criteria

The criteria.

CustomFilter(Int32, CustomFilterCriteria, LogicalOperator, CustomFilterCriteria)

Initializes a new instance of the CustomFilter class.

Declaration
public CustomFilter(int relativeColumnIndex, CustomFilterCriteria criteria1, LogicalOperator logicalOperator, CustomFilterCriteria criteria2)
Parameters
System.Int32 relativeColumnIndex

Relative index of the column.
CustomFilterCriteria criteria1

The first criteria.
LogicalOperator logicalOperator

The logical operator.
CustomFilterCriteria criteria2

The second criteria.

Properties

Criteria1

Gets the first criteria.

Declaration
public CustomFilterCriteria Criteria1 { get; }
Property Value
CustomFilterCriteria

The first criteria.

Criteria2

Gets the second criteria.

Declaration
public CustomFilterCriteria Criteria2 { get; }
Property Value
CustomFilterCriteria

The second criteria.

LogicalOperator

Gets the logical operator.

Declaration
public LogicalOperator LogicalOperator { get; }
Property Value
LogicalOperator

The logical operator.

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

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)