AutoFilter

AutoFilter class

Represents autofiltering for the specified worksheet.

Properties

Name	Type	Description
Sorter	DataSorter	Gets the data sorter.
Range	String	Represents the range to which the specified AutoFilter applies.
ShowFilterButton	boolean	Indicates whether the AutoFilter button for this column is visible.
FilterColumns	FilterColumnCollection	Gets the collection of the filter columns.

Methods

Name	Description
setRange	Sets the range to which the specified AutoFilter applies.
getCellArea	Gets the CellArea where the specified AutoFilter applies to.
addFilter	Adds a filter for a filter column.

MS Excel 2007 supports multiple selection in a filter column. | | addDateFilter | Adds a date filter.

If DateTimeGroupingType is Year, only the param year effects. If DateTiemGroupingType is Month, onl | | removeDateFilter | Removes a date filter.

AutoFilter.Sorter property

Gets the data sorter.

Type: DataSorter

AutoFilter.Range property

Represents the range to which the specified AutoFilter applies.

Type: String

AutoFilter.ShowFilterButton property

Indicates whether the AutoFilter button for this column is visible.

Type: boolean

AutoFilter.FilterColumns property

Gets the collection of the filter columns.

Type: FilterColumnCollection

setRange(row, startColumn, endColumn)

Sets the range to which the specified AutoFilter applies.

Parameter	Type	Description
row	int	Row index.
startColumn	int	Start column index.
endColumn	int	End column Index.

getCellArea() (1 of 2)

Gets the CellArea where the specified AutoFilter applies to.

getCellArea(refreshAppliedRange) (2 of 2)

addFilter(fieldIndex, criteria)

Adds a filter for a filter column.

MS Excel 2007 supports multiple selection in a filter column.

Parameter	Type	Description
fieldIndex	int	The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0).
criteria	String	The specified criteria (a string; for example, “101”). It only can be null or be one of the cells’ value in this column.

addDateFilter(fieldIndex, dateTimeGroupingType, year, month, day, hour, minute, second)

Adds a date filter.

If DateTimeGroupingType is Year, only the param year effects. If DateTiemGroupingType is Month, only the param year and month effect.

Parameter	Type	Description
fieldIndex	int	The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0).
dateTimeGroupingType	int	A DateTimeGroupingType value. The grouping type
year	int	The year.
month	int	The month.
day	int	The day.
hour	int	The hour.
minute	int	The minute.
second	int	The second.

removeDateFilter(fieldIndex, dateTimeGroupingType, year, month, day, hour, minute, second)

Removes a date filter.

If DateTimeGroupingType is Year, only the param year effects. If DateTiemGroupingType is Month, only the param year and month effect.

Parameter	Type	Description
fieldIndex	int	The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0).
dateTimeGroupingType	int	A DateTimeGroupingType value. The grouping type
year	int	The year.
month	int	The month.
day	int	The day.
hour	int	The hour.
minute	int	The minute.
second	int	The second.

removeFilter(fieldIndex, criteria) (1 of 2)

Removes a filter for a filter column.

Parameter	Type	Description
fieldIndex	int	The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0).
criteria	String	The specified criteria (a string; for example, “101”). It only can be null or be one of the cells’ value in this column.

removeFilter(fieldIndex) (2 of 2)

Remove the specific filter.

Parameter	Type	Description
fieldIndex	int	The specific filter index

filter(fieldIndex, criteria)

Filters a list with specified criteria.

Aspose.Cells will remove all other filter setting on this field as Ms Excel 97-2003.

Parameter	Type	Description
fieldIndex	int	The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0).
criteria	String	The specified criteria (a string; for example, “101”).

filterTop10(fieldIndex, isTop, isPercent, itemCount)

Filter the top 10 item in the list

Parameter	Type	Description
fieldIndex	int	The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0).
isTop	boolean	Indicates whether filter from top or bottom
isPercent	boolean	Indicates whether the items is percent or count
itemCount	int	The item count

dynamicFilter(fieldIndex, dynamicFilterType)

Adds a dynamic filter.

Parameter	Type	Description
fieldIndex	int	The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0).
dynamicFilterType	int	A DynamicFilterType value. Dynamic filter type.

addFontColorFilter(fieldIndex, color)

Adds a font color filter.

Parameter	Type	Description
fieldIndex	int	The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0).
color	CellsColor	The CellsColor object.

addFillColorFilter(fieldIndex, pattern, foregroundColor, backgroundColor)

Adds a fill color filter.

Parameter	Type	Description
fieldIndex	int	The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0).
pattern	int	A BackgroundType value. The background pattern type.
foregroundColor	CellsColor	The foreground color.
backgroundColor	CellsColor	The background color.

addIconFilter(fieldIndex, iconSetType, iconId)

Adds an icon filter.

Only supports to add the icon filter. Not supports checking which row is visible if the filter is icon filter.

Parameter	Type	Description
fieldIndex	int	The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0).
iconSetType	int	A IconSetType value. The icon set type.
iconId	int	The icon id.

matchBlanks(fieldIndex)

Match all blank cell in the list.

Parameter	Type	Description
fieldIndex	int	The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0).

matchNonBlanks(fieldIndex)

Match all not blank cell in the list.

Parameter	Type	Description
fieldIndex	int	The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0).

custom(fieldIndex, operatorType1, criteria1) (1 of 2)

Filters a list with a custom criteria.

Parameter	Type	Description
fieldIndex	int	The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0).
operatorType1	int	A FilterOperatorType value. The filter operator type
criteria1	Object	The custom criteria

custom(fieldIndex, operatorType1, criteria1, isAnd, operatorType2, criteria2) (2 of 2)

Filters a list with custom criteria.

Parameter	Type	Description
fieldIndex	int	The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0).
operatorType1	int	A FilterOperatorType value. The filter operator type
criteria1	Object	The custom criteria
isAnd	boolean
operatorType2	int	A FilterOperatorType value. The filter operator type
criteria2	Object	The custom criteria

showAll()

Unhide all rows.

refresh() (1 of 2)

Refresh auto filters to hide or unhide the rows.

Returns: Returns all hidden rows’ indexes.

refresh(hideRows) (2 of 2)

Gets all hidden rows’ indexes.

Parameter	Type	Description
hideRows	boolean	If true, hide the filtered rows.

Returns: Returns all hidden rows indexes.

AutoFillType Enum AutoFitMergedCellsType Enum