FilterColumn
FilterColumn class
Represents a filter for a single column or a column in the table.
class FilterColumn;
Properties
| Property | Type | Description |
|---|---|---|
| isDropdownVisible | boolean | Indicates whether the AutoFilter button for this column is visible. |
| filter | VObject | Gets and sets the condition of filtering data. |
| filterType | FilterType | Gets and sets the type fo filtering data. |
| filterValues | FilterValueCollection | Readonly. Gets Aspose.Cells.FilterValueCollection for filtering data by labels or date time. |
| multipleFilters | MultipleFilterCollection | Gets MultipleFilterCollection for filtering data by labels or date time. |
| customFilters | CustomFilterCollection | Gets CustomFilterCollection for filtering data by custom criteria. |
| colorFilter | ColorFilter | Readonly. Gets Aspose.Cells.ColorFilter for filtering data by color. |
| dynamicFilter | DynamicFilter | Readonly. Gets DynamicFilter for filtering with dynamic criteria. |
| iconFilter | IconFilter | Readonly. Gets IconFilter for filtering data by icon. |
| top10Filter | Top10Filter | Readonly. Gets Top10Filter for filtering data by rank of data. |
| fieldIndex | number | Gets and sets the column offset in the range. |
Methods
| Method | Description |
|---|---|
| selectAll() | Selects all. |
isDropdownVisible
Indicates whether the AutoFilter button for this column is visible.
isDropdownVisible : boolean;
filter
Gets and sets the condition of filtering data.
filter : VObject;
Remarks
NOTE: This member is now obsolete. Instead, please use corresponding property according to FilterColumn.FilterType. And for filter type FilterType.MultipleFilters, the returned object is FilterValueCollection now instead of MultipleFilterCollection. This property will be removed 12 months later since October 2025. Aspose apologizes for any inconvenience you may have experienced.
filterType
Gets and sets the type fo filtering data.
filterType : FilterType;
Remarks
The corresponding filter object will be created when this property is set and corresponding property should be used to get the filter object accordingly:
filterValues
Readonly. Gets Aspose.Cells.FilterValueCollection for filtering data by labels or date time.
filterValues : FilterValueCollection;
Remarks
Sets FilterColumn.FilterType as FilterType.MultipleFilters first,otherwise Null will be returned.
multipleFilters
Gets MultipleFilterCollection for filtering data by labels or date time.
multipleFilters : MultipleFilterCollection;
Remarks
NOTE: This member is now obsolete. Instead,please use FilterColumn.FilterValues property . This property will be removed 12 months later since June 2026. Aspose apologizes for any inconvenience you may have experienced.
customFilters
Gets CustomFilterCollection for filtering data by custom criteria.
customFilters : CustomFilterCollection;
Remarks
NOTE: This setter of this propery is now obsolete. Instead,please use property FilterColumn.FilterType by setting it as FilterType.CustomFilters. This property will be removed 12 months later since June 2026. Aspose apologizes for any inconvenience you may have experienced.
colorFilter
Readonly. Gets Aspose.Cells.ColorFilter for filtering data by color.
colorFilter : ColorFilter;
Remarks
Sets FilterType as FilterType.ColorFilter first,otherwise Null will be returned.
dynamicFilter
Readonly. Gets DynamicFilter for filtering with dynamic criteria.
dynamicFilter : DynamicFilter;
Remarks
Before using this property, please make sure FilterColumn.FilterType is FilterType.DynamicFilter, otherwise null will be returned.
iconFilter
Readonly. Gets IconFilter for filtering data by icon.
iconFilter : IconFilter;
Remarks
Before using this property, please make sure FilterColumn.FilterType is FilterType.IconFilter, otherwise null will be returned.
top10Filter
Readonly. Gets Top10Filter for filtering data by rank of data.
top10Filter : Top10Filter;
Remarks
Before using this property, please make sure FilterColumn.FilterType is FilterType.Top10, otherwise null will be returned.
fieldIndex
Gets and sets the column offset in the range.
fieldIndex : number;
selectAll()
Selects all.
selectAll() : void;