Class AutoFilter

Represents auto filter class.

Inheritance
System.Object
AutoFilter
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 class AutoFilter

Properties

FilterRange

Gets or sets the range of the filter, including the column heading.

Declaration
public CellRange FilterRange { get; set; }
Property Value
CellRange

The range of the filter.

Methods

ClearFilters()

Clears all the filters.

Declaration
public void ClearFilters()

GetFilter(Int32)

Gets the filter applied to the specified column index.

Declaration
public IFilter GetFilter(int relativeColumnIndex)
Parameters
System.Int32 relativeColumnIndex

The column index relative to the filter range.
Returns
IFilter

The filter applied to the column, or null if the column is not filtered.

ReapplyFilter(Int32)

Reapplies the filter applied to the specified column.

Declaration
public void ReapplyFilter(int relativeColumnIndex)
Parameters
System.Int32 relativeColumnIndex

The column index relative to the filter range.

ReapplyFilter(IFilter)

Reapplies the specified filter.

Declaration
public void ReapplyFilter(IFilter filter)
Parameters
IFilter filter

The filter.

RemoveFilter(Int32)

Removes the filter applied to the specified column.

Declaration
public bool RemoveFilter(int relativeColumnIndex)
Parameters
System.Int32 relativeColumnIndex

The column index relative to the filter range.
Returns
System.Boolean

A value indicating whether the filter was successfully found and removed.

RemoveFilter(IFilter)

Removes the specified filter.

Declaration
public bool RemoveFilter(IFilter filter)
Parameters
IFilter filter

The filter.
Returns
System.Boolean

A value indicating whether the filter was successfully found and removed.

SetFilter(IFilter)

Sets the specified filter to the filter range.

Declaration
public void SetFilter(IFilter filter)
Parameters
IFilter filter

The filter.

SetFilters(IEnumerable<IFilter>)

Sets the specified filters to the filtered range.

Declaration
public void SetFilters(IEnumerable<IFilter> filters)
Parameters
System.Collections.Generic.IEnumerable<IFilter> filters

The filters.