Static $tStatic nextReturns the total region including the filter headers (read-only).
Returns the region that the filters and sort settings are applied to (read-only).
Gets the settings which determine how the data within the worksheet's filer region should be sorted.
Note: Sort conditions are not constantly evaluated as data within the region changes. Sort conditions are applied to the region only when they are are added or removed or when the [[reapplySortConditions]] method is called.
[[reapplySortConditions]]
Applies an [[AverageFilter]] to the column.
[[InvalidOperationException]] If the [[region]] was not set.
[[ArgumentOutOfRangeException]] If the relativeColumnIndex is outside of the [[region]].
[[InvalidEnumArgumentException]] 'type' is not defined in the [[AverageFilterType]] enumeration.
A zero based column index relative to the [[region]]
The value indicating whether to filter in values below or above the average of the data range.
Applies a [[CustomFilter]] to the column.
Note: If the filter condition value is longer than 255 characters in length and the workbook is saved in one of the 2003 formats, the correct rows will be hidden in the saved file, but the filter will be missing from the column.
[[ArgumentNullException]] 'condition' is null.
[[InvalidOperationException]] If the [[region]] was not set.
[[ArgumentOutOfRangeException]] If the relativeColumnIndex is outside of the [[region]].
A zero based column index relative to the [[region]]
The condition which must pass for the data to be filtered in.
Applies a [[CustomFilter]] to the column.
If 'condition2' is null, the 'conditionalOperator' value is irrelevant.
Note: If one of the filter condition values is longer than 255 characters in length and the workbook is saved in one of the 2003 formats, the correct rows will be hidden in the saved file, but the filter will be missing from the column.
[[ArgumentNullException]] 'condition1' is null.
[[InvalidEnumArgumentException]] 'conditionalOperator' is not defined in the [[ConditionalOperator]] enumeration.
[[InvalidOperationException]] If the [[region]] was not set.
[[ArgumentOutOfRangeException]] If the relativeColumnIndex is outside of the [[region]].
A zero based column index relative to the [[region]]
The first condition used to filter the data.
The second condition used to filter the data.
The operator which defines how to logically combine 'condition1' and 'condition2'.
Applies an [[DatePeriodFilter]] to the column.
If the 'type' is Month, a 'value' of 1 indicates January, 2 indicates February, and so on. If type is Quarter, a value of 1 indicates Quarter 1, and so on.
[[InvalidOperationException]] If the [[region]] was not set.
[[ArgumentOutOfRangeException]] If the relativeColumnIndex is outside of the [[region]].
[[InvalidEnumArgumentException]] 'type' is not defined in the [[DatePeriodFilterType]] enumeration.
[[ArgumentException]] 'type' is Quarter and 'value' is less than 1 or greater than 4 or type is Month and value is less than 1 or greater than 12.
A zero based column index relative to the [[region]]
The type of date period to filter in.
The 1-based value of the month or quarter to filter in.
Applies a [[FillFilter]] to the column.
[[ArgumentNullException]] 'fill' is null.
[[InvalidOperationException]] If the [[region]] was not set.
[[ArgumentOutOfRangeException]] If the relativeColumnIndex is outside of the [[region]].
A zero based column index relative to the [[region]]
A [[CellFill]] by which the cells should be filtered.
Applies a [[FixedValuesFilter]] to the column.
[[ArgumentNullException]] 'dateGroups' is null.
[[InvalidEnumArgumentException]] 'calendarType' is not defined in the [[CalendarType]] enumeration.
[[ArgumentNullException]] A FixedDateGroup in the 'dateGroups' collection is null.
[[ArgumentException]] Multiple items in 'dateGroups' are equal to each other.
[[InvalidOperationException]] 'includeBlanks' is False and 'dateGroups' has no items. At least one value must be allowed.
[[InvalidOperationException]] If the [[region]] was not set.
[[ArgumentOutOfRangeException]] If the relativeColumnIndex is outside of the [[region]].
A zero based column index relative to the [[region]]
The value which indicates whether blank cells should be filtered in.
The calendar type used to interpret values in the 'dateGroups' collection.
The collection of fixed date groups which should be filtered in.
Applies a [[FontColorFilter]] to the column.
[[ArgumentNullException]] 'fontColorInfo' is null.
[[InvalidOperationException]] If the [[region]] was not set.
[[ArgumentOutOfRangeException]] If the relativeColumnIndex is outside of the [[region]].
A zero based column index relative to the [[region]]
A [[WorkbookColorInfo]] which describes the font color by which the cells should be filtered.
Applies a [[FontColorFilter]] to the column.
[[ArgumentNullException]] 'fontColor' is empty.
[[InvalidOperationException]] If the [[region]] was not set.
[[ArgumentOutOfRangeException]] If the relativeColumnIndex is outside of the [[region]].
A zero based column index relative to the [[region]]
The font color by which the cells should be filtered.
Applies a [[IconFilter]] to the column.
[[ArgumentException]] If the icon set is not valid.
[[IndexOutOfRangeException]] If the index is less than zero or greater than or equal to the number of icons in the icon set..
[[InvalidOperationException]] The [[WorksheetTable.isFilterUIVisible]] value of the owning table is False. Filters cannot be applied when the header row or filter button is hidden.
[[InvalidOperationException]] If column was removed from the table.
[[ArgumentOutOfRangeException]] If the relativeColumnIndex is outside of the [[region]].
[[InvalidEnumArgumentException]] 'iconSet' is not defined in the [[FormatConditionIconSet]] enumeration.
A zero based column index relative to the [[region]]
The icon set containing the icon.
The zero-based index of the icon in the set or null for 'NoCellIcon'.
Applies a [[RelativeDateRangeFilter]] to the column.
The RelativeDateRangeFilter allows you to filter in dates which are in the previous, current, or next time period relative to the date when the filter was applied. The time periods available are day, week, month, quarter, year. So when using the previous filter type with a day duration, a 'yesterday' filter is created. Or when using a current filter type with a year duration, a 'this year' filter is created. However, these filters compare the data against the date when the filter was created. So a 'this year' filter created in 1999 will filter in all cells containing dates in 1999, even if the workbook is opened in 2012.
[[InvalidEnumArgumentException]] 'offset' is not defined in the [[RelativeDateRangeOffset]] enumeration.
[[InvalidEnumArgumentException]] 'duration' is not defined in the [[RelativeDateRangeDuration]] enumeration.
[[InvalidOperationException]] If the [[region]] was not set.
[[ArgumentOutOfRangeException]] If the relativeColumnIndex is outside of the [[region]].
A zero based column index relative to the [[region]]
The offset of relative filter. This combined with the 'duration' determines the full range of accepted dates.
The duration of the full range of accepted dates.
Applies a [[TopOrBottomFilter]] to the column which will filter in the top 10 values in the list of sorted values.
[[InvalidOperationException]] If the [[region]] was not set.
[[ArgumentOutOfRangeException]] If the relativeColumnIndex is outside of the [[region]].
A zero based column index relative to the [[region]]
Applies a [[TopOrBottomFilter]] to the column.
[[InvalidEnumArgumentException]] 'type' is not defined in the [[TopOrBottomFilterType]] enumeration.
[[ArgumentOutOfRangeException]] 'value' is less than 1 or greater than 500.
[[InvalidOperationException]] If the [[region]] was not set.
[[ArgumentOutOfRangeException]] If the relativeColumnIndex is outside of the [[region]].
A zero based column index relative to the [[region]]
The type of the filter.
The number or percentage of value of values which should be filtered in.
Applies a [[YearToDateFilter]] to the column.
[[InvalidOperationException]] If the [[region]] was not set.
[[ArgumentOutOfRangeException]] If the relativeColumnIndex is outside of the [[region]].
A zero based column index relative to the [[region]]
Clears the filter that is applied to a specific column.
[[InvalidOperationException]] If the [[region]] was not set.
[[ArgumentOutOfRangeException]] If the relativeColumnIndex is outside of the [[region]].
A zero based column index relative to the [[region]]
Gets the filter that is applied to a specific column.
[[InvalidOperationException]] If the [[region]] was not set.
[[ArgumentOutOfRangeException]] If the relativeColumnIndex is outside of the [[region]].
A zero based column index relative to the [[region]]
Re-filters all data cells in the filter region based on the applied filters.
Filters are not constantly evaluated as data within the region changes. Filters are applied to the region only when they are added or removed or when the ReapplyFilters method is called.
If no filters are applied this method will not do anything to the data.
Note: When the filters are reevaluated, the rows of any cells which don't meet the filter criteria of their column will be hidden. When a row is filtered out, the entire row is hidden from the worksheet, so any data outside the table but in the same row will also be hidden.
[[clearFilters]]
Sets the region where the filter settings should be applied
The [[Workbook.cellReferenceMode]] of the workbook will be used to parse the region address.
Note: setting the region will clear any applied filters or sort criteria.
[[InvalidOperationException]] If the region intersects with a table of other reserved area in the worksheet.
The address of the new region.
Sets the region where the filter settings should be applied
Note: setting the region will clear any applied filters or sort criteria.
[[InvalidOperationException]] If the region intersects with a table of other reserved area in the worksheet.
The address of the new region.
The reference to use the parse the address.
Static compareStatic compareStatic equalsStatic equalsStatic getStatic getStatic getStatic referenceStatic static
Exposes methods to identify a region in the wroksheet and to apply filters and optionally sort criteria to that region.