New to Telerik Document ProcessingStart a free 30-day trial

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

Definition

Namespace:Telerik.Windows.Documents.Spreadsheet.Model.Filtering

Assembly:Telerik.Windows.Documents.Spreadsheet.dll

Syntax:

C#
public class AutoFilter

Inheritance: objectAutoFilter

Methods

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

C#
public void ClearFilters()

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

C#
public IFilter GetFilter(int relativeColumnIndex)
Parameters:relativeColumnIndexint

The column index relative to the filter range.

Returns:

IFilter

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

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

C#
public void ReapplyFilter(IFilter filter)
Parameters:filterIFilter

The filter.

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

C#
public void ReapplyFilter(int relativeColumnIndex)
Parameters:relativeColumnIndexint

The column index relative to the filter range.

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

C#
public bool RemoveFilter(IFilter filter)
Parameters:filterIFilter

The filter.

Returns:

bool

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

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

C#
public bool RemoveFilter(int relativeColumnIndex)
Parameters:relativeColumnIndexint

The column index relative to the filter range.

Returns:

bool

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

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

C#
public void SetFilter(IFilter filter)
Parameters:filterIFilter

The filter.

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

C#
public void SetFilters(IEnumerable<IFilter> filters)
Parameters:filtersIEnumerable<IFilter>

The filters.

Properties

Gets or sets the range to which filtering is applied, including the header row with column names.

C#
public CellRange FilterRange { get; set; }
Property Value:

The range of the filter.