ClassAutoFilter
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:
public class AutoFilterInheritance: objectAutoFilter
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
The range of the filter.
Methods
ClearFilters()
Removes all filters from all columns and unhides all filtered rows.
Declaration
public void ClearFilters()GetFilter(int)
Retrieves the filter applied to the specified column, or null if no filter exists on that column.
ReapplyFilter(IFilter)
Reapplies the specified filter to re-evaluate row visibility based on current cell values.
Declaration
public void ReapplyFilter(IFilter filter)Parameters
filter
The filter.
ReapplyFilter(int)
Reapplies the filter on the specified column to re-evaluate row visibility based on current cell values.
Declaration
public void ReapplyFilter(int relativeColumnIndex)Parameters
relativeColumnIndex
The column index relative to the filter range.
RemoveFilter(IFilter)
Removes the specified filter and unhides rows that were hidden solely by that filter.
RemoveFilter(int)
Removes the filter from the specified column and unhides rows that were hidden solely by that filter.
SetFilter(IFilter)
Applies the specified filter to its target column, replacing any existing filter on that column.
Declaration
public void SetFilter(IFilter filter)Parameters
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
filters
The filters.