Documentation

Class TopFilter

Describes a filter which hides or shows the cells based on the cell fill color.

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

Constructors

TopFilter(Int32)

Initializes a new instance of the TopFilter class.

Declaration
public TopFilter(int relativeColumnIndex)
Parameters
System.Int32 relativeColumnIndex

The relative index of the column.

TopFilter(Int32, TopFilterType, Double)

Initializes a new instance of the TopFilter class.

Declaration
public TopFilter(int relativeColumnIndex, TopFilterType topFilterType, double value)
Parameters
System.Int32 relativeColumnIndex

The relative index of the column.
TopFilterType topFilterType

Type of the top filter.
System.Double value

Gets the value which indicates how many or what percent of the items covered by the filter should be shown.

Properties

TopFilterType

Gets the type of the top filter.

Declaration
public TopFilterType TopFilterType { get; }
Property Value
TopFilterType

The type of the top filter.

Value

Gets the value which indicates how many or what percent of the items covered by the filter should be shown.

Declaration
public double Value { get; }
Property Value
System.Double

The value.

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)