Exposes methods to identify a region in the wroksheet and to apply filters and optionally sort criteria to that region.
Inheritance
object
Properties
Section titled "Properties"Region
Section titled "Region"Returns the total region including the filter headers (read-only).
public WorksheetRegion Region { get; }SortAndFilterAreaRegion
Section titled "SortAndFilterAreaRegion"Returns the region that the filters and sort settings are applied to (read-only).
public WorksheetRegion SortAndFilterAreaRegion { get; }SortSettings
Section titled "SortSettings"Gets the settings which determine how the data within the worksheet's filer region should be sorted.
public RelativeIndexSortSettings SortSettings { get; }Methods
Section titled "Methods"ApplyAverageFilter(int, AverageFilterType)
Section titled "ApplyAverageFilter(int, AverageFilterType)"Applies an to the column.
public AverageFilter ApplyAverageFilter(int relativeColumnIndex, AverageFilterType type)Parameters
- relativeColumnIndex:
int - type:
AverageFilterType
Returns any
ApplyCustomFilter(int, CustomFilterCondition)
Section titled "ApplyCustomFilter(int, CustomFilterCondition)"Applies a to the column.
public CustomFilter ApplyCustomFilter(int relativeColumnIndex, CustomFilterCondition condition)Parameters
- relativeColumnIndex:
int - condition:
CustomFilterCondition
Returns any
ApplyCustomFilter(int, CustomFilterCondition, CustomFilterCondition, ConditionalOperator)
Section titled "ApplyCustomFilter(int, CustomFilterCondition, CustomFilterCondition, ConditionalOperator)"Applies a to the column.
public CustomFilter ApplyCustomFilter(int relativeColumnIndex, CustomFilterCondition condition1, CustomFilterCondition condition2, ConditionalOperator conditionalOperator)Parameters
- relativeColumnIndex:
int - condition1:
CustomFilterCondition - condition2:
CustomFilterCondition - conditionalOperator:
ConditionalOperator
Returns any
ApplyDatePeriodFilter(int, DatePeriodFilterType, int)
Section titled "ApplyDatePeriodFilter(int, DatePeriodFilterType, int)"Applies an to the column.
public DatePeriodFilter ApplyDatePeriodFilter(int relativeColumnIndex, DatePeriodFilterType type, int value)Parameters
- relativeColumnIndex:
int - type:
DatePeriodFilterType - value:
int
Returns any
ApplyFillFilter(int, CellFill)
Section titled "ApplyFillFilter(int, CellFill)"Applies a to the column.
public FillFilter ApplyFillFilter(int relativeColumnIndex, CellFill fill)Parameters
- relativeColumnIndex:
int - fill:
CellFill
Returns any
ApplyFixedValuesFilter(int, bool, CalendarType, params FixedDateGroup[])
Section titled "ApplyFixedValuesFilter(int, bool, CalendarType, params FixedDateGroup[])"Applies a to the column.
public FixedValuesFilter ApplyFixedValuesFilter(int relativeColumnIndex, bool includeBlanks, CalendarType calendarType, params FixedDateGroup[] dateGroups)Parameters
- relativeColumnIndex:
int - includeBlanks:
bool - calendarType:
CalendarType - dateGroups:
FixedDateGroup[]
Returns any
ApplyFixedValuesFilter(int, bool, CalendarType, IEnumerable<FixedDateGroup>)
Section titled "ApplyFixedValuesFilter(int, bool, CalendarType, IEnumerable<FixedDateGroup>)"Applies a to the column.
public FixedValuesFilter ApplyFixedValuesFilter(int relativeColumnIndex, bool includeBlanks, CalendarType calendarType, IEnumerable<FixedDateGroup> dateGroups)Parameters
- relativeColumnIndex:
int - includeBlanks:
bool - calendarType:
CalendarType - dateGroups:
IEnumerable
Returns any
ApplyFixedValuesFilter(int, bool, IEnumerable<FixedDateGroup>)
Section titled "ApplyFixedValuesFilter(int, bool, IEnumerable<FixedDateGroup>)"Applies a to the column.
public FixedValuesFilter ApplyFixedValuesFilter(int relativeColumnIndex, bool includeBlanks, IEnumerable<FixedDateGroup> dateGroups)Parameters
- relativeColumnIndex:
int - includeBlanks:
bool - dateGroups:
IEnumerable
Returns any
ApplyFixedValuesFilter(int, bool, IEnumerable<string>)
Section titled "ApplyFixedValuesFilter(int, bool, IEnumerable<string>)"Applies a to the column.
public FixedValuesFilter ApplyFixedValuesFilter(int relativeColumnIndex, bool includeBlanks, IEnumerable<string> displayValues)Parameters
- relativeColumnIndex:
int - includeBlanks:
bool - displayValues:
IEnumerable
Returns any
ApplyFixedValuesFilter(int, bool, params string[])
Section titled "ApplyFixedValuesFilter(int, bool, params string[])"Applies a to the column.
public FixedValuesFilter ApplyFixedValuesFilter(int relativeColumnIndex, bool includeBlanks, params string[] displayValues)Parameters
- relativeColumnIndex:
int - includeBlanks:
bool - displayValues:
string[]
Returns any
ApplyFontColorFilter(int, Color)
Section titled "ApplyFontColorFilter(int, Color)"Applies a to the column.
public FontColorFilter ApplyFontColorFilter(int relativeColumnIndex, Color fontColor)Parameters
- relativeColumnIndex:
int - fontColor:
Color
Returns any
ApplyFontColorFilter(int, WorkbookColorInfo)
Section titled "ApplyFontColorFilter(int, WorkbookColorInfo)"Applies a to the column.
public FontColorFilter ApplyFontColorFilter(int relativeColumnIndex, WorkbookColorInfo fontColorInfo)Parameters
- relativeColumnIndex:
int - fontColorInfo:
WorkbookColorInfo
Returns any
ApplyIconFilter(int, FormatConditionIconSet, int?)
Section titled "ApplyIconFilter(int, FormatConditionIconSet, int?)"Applies a to the column.
public IconFilter ApplyIconFilter(int relativeColumnIndex, FormatConditionIconSet iconSet, int? iconIndex)Parameters
- relativeColumnIndex:
int - iconSet:
FormatConditionIconSet - iconIndex:
int?
Returns any
ApplyRelativeDateRangeFilter(int, RelativeDateRangeOffset, RelativeDateRangeDuration)
Section titled "ApplyRelativeDateRangeFilter(int, RelativeDateRangeOffset, RelativeDateRangeDuration)"Applies a to the column.
public RelativeDateRangeFilter ApplyRelativeDateRangeFilter(int relativeColumnIndex, RelativeDateRangeOffset offset, RelativeDateRangeDuration duration)Parameters
- relativeColumnIndex:
int - offset:
RelativeDateRangeOffset - duration:
RelativeDateRangeDuration
Returns any
ApplyTopOrBottomFilter(int)
Section titled "ApplyTopOrBottomFilter(int)"Applies a to the column which will filter in the top 10 values in the list of sorted values.
public TopOrBottomFilter ApplyTopOrBottomFilter(int relativeColumnIndex)Parameters
- relativeColumnIndex:
int
Returns any
ApplyTopOrBottomFilter(int, TopOrBottomFilterType, int)
Section titled "ApplyTopOrBottomFilter(int, TopOrBottomFilterType, int)"Applies a to the column.
public TopOrBottomFilter ApplyTopOrBottomFilter(int relativeColumnIndex, TopOrBottomFilterType type, int value)Parameters
- relativeColumnIndex:
int - type:
TopOrBottomFilterType - value:
int
Returns any
ApplyYearToDateFilter(int)
Section titled "ApplyYearToDateFilter(int)"Applies a to the column.
public YearToDateFilter ApplyYearToDateFilter(int relativeColumnIndex)Parameters
- relativeColumnIndex:
int
Returns any
ClearFilter(int)
Section titled "ClearFilter(int)"Clears the filter that is applied to a specific column.
public void ClearFilter(int relativeColumnIndex)Parameters
- relativeColumnIndex:
int
Returns any
ClearFilters()
Section titled "ClearFilters()"Clears all previously applied filters
public void ClearFilters()Returns any
ClearRegion()
Section titled "ClearRegion()"Clears the region as well as any existing filters and sort criteria
public void ClearRegion()Returns any
GetFilter(int)
Section titled "GetFilter(int)"Gets the filter that is applied to a specific column.
public Filter GetFilter(int relativeColumnIndex)Parameters
- relativeColumnIndex:
int
Returns any
ReapplyFilters()
Section titled "ReapplyFilters()"Re-filters all data cells in the filter region based on the applied filters.
public void ReapplyFilters()Returns any
ReapplySortConditions()
Section titled "ReapplySortConditions()"Re-sorts all data cells in the region based on the sort conditions.
public void ReapplySortConditions()Returns any
SetRegion(string)
Section titled "SetRegion(string)"Sets the region where the filter settings should be applied
public void SetRegion(string address)Parameters
- address:
string
Returns any
SetRegion(string, CellReferenceMode)
Section titled "SetRegion(string, CellReferenceMode)"Sets the region where the filter settings should be applied
public void SetRegion(string address, CellReferenceMode cellReferenceMode)Parameters
- address:
string - cellReferenceMode:
CellReferenceMode