Click or drag to resize

AutoFiltersCollection Class

Represents a collection of automatic filters that can be applied to data in a spreadsheet or similar data grid. Each filter in the collection can define criteria for displaying rows or columns based on specific conditions.
Inheritance Hierarchy
System Object
Spire.Xls.Core.Spreadsheet.Collections CollectionBase Object
Spire.Xls.Core.Spreadsheet.Collections CollectionExtended Object
Spire.Xls.Core.Spreadsheet.Collections XlsAutoFiltersCollection
Spire.Xls.Collections AutoFiltersCollection

Namespace: Spire.Xls.Collections
Assembly: Spire.XLS (in Spire.XLS.dll) Version: 15.4.0.0 (15.4.0.5046)
Syntax
Copy 
public class AutoFiltersCollection : XlsAutoFiltersCollection

The AutoFiltersCollection type exposes the following members.

Properties
Name Description
Public property AddressR1C1
Gets addres of filtered range in R1C1 style. Read only.
(Inherited from XlsAutoFiltersCollection .)
Public property Capacity
Gets or sets the number of elements that the System.Collections.CollectionBase can contain.
(Inherited from CollectionBase T .)
Public property Count
Gets the total number of items in the collection.
(Inherited from XlsAutoFiltersCollection .)
Public property HasFiltered
Indicates whether sheet has filtered range.
(Inherited from XlsAutoFiltersCollection .)
Protected property InnerList
Gets the list of elements in the instance.
(Inherited from CollectionBase T .)
Public property IsReadOnly
Gets a value indicating whether the collection is read-only.
(Inherited from CollectionBase T .)
Public property Item
Get auto filter item..
Protected property List
Gets the list of elements in the instance.
(Inherited from CollectionBase T .)
Public property Parent
Read-oonly. The parent object for the specified object.
(Inherited from CollectionExtended T .)
Public property Range
Range to be filtered.
Public property Sorter
Gets the DataSorter instance associated with the current object. If the instance does not exist, it initializes a new instance of DataSorter.
(Inherited from XlsAutoFiltersCollection .)
Public property Worksheet
Returns parent worksheet. Read-only.
Top
Methods
Name Description
Public method Add
Adds an item to the collection.trigger OnInsert and OnInsertComplete method when set item
(Inherited from CollectionBase T .)
Public method AddDateFilter(Int32, DateTimeGroupingType, Int32, Int32, Int32, Int32, Int32, Int32)
Adds a date filter for a filter column.
Public method AddDateFilter(IAutoFilter, DateTimeGroupingType, Int32, Int32, Int32, Int32, Int32, Int32)
Adds a date filter to the specified column based on the provided date grouping type and date components.
Public method AddFillColorFilter(Int32, Color)
Adds a fill color filter.
Public method AddFillColorFilter(IAutoFilter, Color)
Adds a color filter to the specified column in an Excel auto filter.
Public method AddFillColorFilter(Int32, ExcelPatternType, Color, Color)
Adds a fill color filter.
Public method AddFilter(Int32, String)
Adds a filter for a filter column.
Public method AddFilter(IAutoFilter, String)
Adds a filter to the specified column with the given criteria.
Public method AddFontColorFilter(Int32, Color)
Adds a font color filter.
Public method AddFontColorFilter(IAutoFilter, Color)
Adds a filter to the specified column to show only cells with the given font color.
Public method AddIconFilter
Adds an icon filter.
Public method Clear
Clears all items from the collection.
Public method ClearFilter(Int32)
Delete the column filter by column index(filters column index not sheet column index)
Public method ClearFilter(String)
Delete the column filter by column name
Public method Clone(Object)
Creates copy of the collection.
(Inherited from CollectionExtended T .)
Public method Clone(XlsWorksheet)
Clones current instance.
(Inherited from XlsAutoFiltersCollection .)
Public method Contains
Determines whether the collection contains a specific item.
(Inherited from CollectionBase T .)
Public method CopyTo
Copies the elements of the collection to an array, starting at a particular array index.
(Inherited from CollectionBase T .)
Public method CustomFilter(Int32, FilterOperatorType, Object)
Filters a list with a custom criteria.
Public method CustomFilter(FilterColumn, FilterOperatorType, Object)
Applies a custom filter to a specified column using the given operator and criteria.
Public method CustomFilter(Int32, FilterOperatorType, Object, Boolean, FilterOperatorType, Object)
Filters a list with custom criterias.
Public method CustomFilter(FilterColumn, FilterOperatorType, Object, Boolean, FilterOperatorType, Object)
Applies a custom filter to a specified column using two sets of criteria and logical operators.
Public method DynamicFilter(Int32, DynamicFilterType)
Adds a dynamic filter.
Public method DynamicFilter(IAutoFilter, DynamicFilterType)
Applies a dynamic filter to the specified column.
Public method EnsureCapacity
Enlarges internal storage if necessary.
(Inherited from CollectionExtended T .)
Public method Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object .)
Public method Filter
Filter the data.
Public method Filter(Boolean)
Gets all hidden rows's indexes.
Public method FilterTop10(Int32, Boolean, Boolean, Int32)
Filter the top 10 item in the list
Public method FilterTop10(IAutoFilter, Boolean, Boolean, Int32)
Filter the top 10 item in the list
Protected method Finalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object .)
Protected method FindParent(Type)
Method used to find parent within a specific type.
(Inherited from CollectionExtended T .)
Protected method FindParent(Type, Boolean)
Method used to find parent within a specific type.
(Inherited from CollectionExtended T .)
Public method GetEnumerator
Returns an enumerator that iterates through this instance.
(Inherited from CollectionBase T .)
Public method GetHashCode
Serves as the default hash function.
(Inherited from Object .)
Public method GetType
Gets the Type of the current instance.
(Inherited from Object .)
Public method IndexOf
Returns the zero-based index of the first occurrence of a specified item within the collection.
(Inherited from CollectionBase T .)
Public method Insert
Inserts an element into the list at the specified index.
(Inherited from CollectionBase T .)
Public method MatchBlanks(Int32)
Match all blank cell in the list.
Public method MatchBlanks(IAutoFilter)
Match all blank cell in the list.
Public method MatchNonBlanks(Int32)
Match all not blank cell in the list.
Public method MatchNonBlanks(FilterColumn)
Match all not blank cell in the list.
Protected method MemberwiseClone
Creates a shallow copy of the current Object .
(Inherited from Object .)
Protected method OnClear
OnClear is invoked before Clear behavior.
(Inherited from CollectionExtended T .)
Protected method OnClearComplete
OnClear is invoked after Clear behavior.
(Inherited from CollectionExtended T .)
Protected method OnInsert
Performs additional processes before inserting a new element into the collection.
(Inherited from CollectionExtended T .)
Protected method OnInsertComplete
Performs additional processes after inserting a new element into the collection.
(Inherited from CollectionExtended T .)
Protected method OnRemove
Performs additional processes before removing an element from the collection.
(Inherited from CollectionExtended T .)
Protected method OnRemoveComplete
Performs additional processes after removing an element from the collection.
(Inherited from CollectionExtended T .)
Protected method OnSet
Performs additional processes before setting a value in the collection.
(Inherited from CollectionExtended T .)
Protected method OnSetComplete
Performs additional processes after setting a value in the collection.
(Inherited from CollectionExtended T .)
Public method QuickFilter(Int32, String)
Filters a list with specified criteria.
Public method QuickFilter(IAutoFilter, String)
Applies a simple filter to the specified column based on the given criteria.
Public method Remove
Removes the first occurrence of a specific object from the collection.
(Inherited from CollectionBase T .)
Public method RemoveAt
Removes the element at the specified index of this instance.
(Inherited from CollectionBase T .)
Public method RemoveDateFilter
Removes a date filter.
Public method RemoveFilter
Removes a filter for a filter column.
Protected method SetParent
Sets parent object for class.
(Inherited from CollectionExtended T .)
Public method ToString
Returns a string that represents the current object.
(Inherited from Object .)
Top
Events
See Also