ClassSpreadAutoFilter
Represents an auto-filter range applied to a worksheet with optional filter column definitions.
Definition
Namespace:Telerik.Documents.SpreadsheetStreaming
Assembly:Telerik.Documents.SpreadsheetStreaming.dll
Syntax:
public class SpreadAutoFilterInheritance: objectSpreadAutoFilter
Constructors
SpreadAutoFilter(int, int, int, int)
Initializes a new instance of the SpreadAutoFilter class with a range only (no filter columns).
Declaration
public SpreadAutoFilter(int fromRowIndex, int fromColumnIndex, int toRowIndex, int toColumnIndex)Parameters
fromRowIndex
The start row index of the auto-filter range.
fromColumnIndex
The start column index of the auto-filter range.
toRowIndex
The end row index of the auto-filter range.
toColumnIndex
The end column index of the auto-filter range.
Exceptions
Thrown 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.
SpreadAutoFilter(int, int, int, int, IList<SpreadFilterColumn>)
Initializes a new instance of the SpreadAutoFilter class with a range and filter columns.
Declaration
public SpreadAutoFilter(int fromRowIndex, int fromColumnIndex, int toRowIndex, int toColumnIndex, IList<SpreadFilterColumn> filterColumns)Parameters
fromRowIndex
The start row index of the auto-filter range.
fromColumnIndex
The start column index of the auto-filter range.
toRowIndex
The end row index of the auto-filter range.
toColumnIndex
The end column index of the auto-filter range.
filterColumns
The filter column definitions. Can be null.
Exceptions
Thrown when any index is out of the valid Excel range.
Thrown when a RelativeColumnIndex exceeds the auto-filter column span, or when two filter columns share the same RelativeColumnIndex.
Properties
FilterColumns
Gets the filter column definitions applied to specific columns within the auto-filter range.
Declaration
public IList<SpreadFilterColumn> FilterColumns { get; }Property Value
FromColumnIndex
Gets the start column index of the auto-filter range.
FromRowIndex
Gets the start row index of the auto-filter range.
ToColumnIndex
Gets the end column index of the auto-filter range.
ToRowIndex
Gets the end row index of the auto-filter range.