SpreadAutoFilter
Represents an auto-filter range applied to a worksheet with optional filter column definitions.
When FilterColumns is empty, all data rows remain visible (no filtering criteria are evaluated). Dropdown buttons are still emitted on the header row columns.
Use SetAutoFilter(SpreadAutoFilter) to emit filter rules only (no row hiding). Use BeginFiltering(SpreadAutoFilter) / EndFiltering() to emit filter rules AND hide non-matching rows during streaming.
Definition
Namespace:Telerik.Documents.SpreadsheetStreaming
Assembly:Telerik.Documents.SpreadsheetStreaming.dll
Syntax:
public class SpreadAutoFilterInheritance: objectSpreadAutoFilter
Constructors
Initializes a new instance of the SpreadAutoFilter class with a range and filter columns.
public SpreadAutoFilter(int fromRowIndex, int fromColumnIndex, int toRowIndex, int toColumnIndex, IList<SpreadFilterColumn> filterColumns)The start row index of the auto-filter range.
fromColumnIndexintThe start column index of the auto-filter range.
toRowIndexintThe end row index of the auto-filter range.
toColumnIndexintThe end column index of the auto-filter range.
filterColumnsIList<SpreadFilterColumn>The filter column definitions. Can be null.
Exceptions: ArgumentOutOfRangeExceptionThrown when any index is out of the valid Excel range.
ArgumentExceptionThrown when a RelativeColumnIndex exceeds the auto-filter column span, or when two filter columns share the same RelativeColumnIndex.
Initializes a new instance of the SpreadAutoFilter class with a range only (no filter columns).
public SpreadAutoFilter(int fromRowIndex, int fromColumnIndex, int toRowIndex, int toColumnIndex)The start row index of the auto-filter range.
fromColumnIndexintThe start column index of the auto-filter range.
toRowIndexintThe end row index of the auto-filter range.
toColumnIndexintThe end column index of the auto-filter range.
Exceptions: ArgumentOutOfRangeExceptionThrown when any index is negative, toRowIndex exceeds the maximum Excel row,
toColumnIndex exceeds the maximum Excel column, or the from-indices exceed the to-indices.
Properties
Gets the filter column definitions applied to specific columns within the auto-filter range.
public IList<SpreadFilterColumn> FilterColumns { get; }Gets the start column index of the auto-filter range.
public int FromColumnIndex { get; }Gets the start row index of the auto-filter range.
public int FromRowIndex { get; }Gets the end column index of the auto-filter range.
public int ToColumnIndex { get; }Gets the end row index of the auto-filter range.
public int ToRowIndex { get; }