Class AutoFilter

Manages column-based filtering for a worksheet range, hiding or showing rows based on applied filter criteria.

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 to which filtering is applied, including the header row with column names.

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

The range of the filter.

Methods

ClearFilters()

Removes all filters from all columns and unhides all filtered rows.

Declaration
public void ClearFilters()

GetFilter(Int32)

Retrieves the filter applied to the specified column, or null if no filter exists on that column.

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 on the specified column to re-evaluate row visibility based on current cell values.

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

The column index relative to the filter range.

ReapplyFilter(IFilter)

Reapplies the specified filter to re-evaluate row visibility based on current cell values.

Declaration
public void ReapplyFilter(IFilter filter)
Parameters
IFilter filter

The filter.

RemoveFilter(Int32)

Removes the filter from the specified column and unhides rows that were hidden solely by that filter.

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 and unhides rows that were hidden solely by that 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)

Applies the specified filter to its target column, replacing any existing filter on that column.

Declaration
public void SetFilter(IFilter filter)
Parameters
IFilter filter

The filter.

SetFilters(IEnumerable<IFilter>)

Applies multiple filters to the filtered range in a single operation.

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

The filters.

Extension Methods