com.aspose.cells
Class AutoFilter

java.lang.Object
    com.aspose.cells.AutoFilter

public class AutoFilter 
extends java.lang.Object

//Creating a file stream containing the Excel file to be opened
//Instantiating a Workbook object
Workbook workbook = new Workbook("template.xlsx");
//Accessing the first worksheet in the Excel file
Worksheet worksheet = workbook.getWorksheets().get(0);
//Creating AutoFilter by giving the cells range of the heading row
worksheet.getAutoFilter().setRange("A1:B1");
//Filtering columns with specified values
worksheet.getAutoFilter().filter(1, "Bananas");
//Saving the modified Excel file.
workbook.save("output.xls");

public DataSorter getSorter()

Gets the data sorter.

public java.lang.String getRange() / public void setRange(java.lang.String value)

Represents the range to which the specified AutoFilter applies.

public boolean getShowFilterButton() / public void setShowFilterButton(boolean value)

Indicates whether the AutoFilter button for this column is visible.

public FilterColumnCollection getFilterColumns()

Gets the collection of the filter columns.

public void setRange(int row, int startColumn, int endColumn)

Sets the range to which the specified AutoFilter applies.

Parameters:

row - Row index.

startColumn - Start column index.

endColumn - End column Index.

public CellArea getCellArea()

Gets the CellArea where the specified AutoFilter applies to.

Returns:

public void addFilter(int fieldIndex, java.lang.String criteria)

Adds a filter for a filter column.

MS Excel 2007 supports multiple selection in a filter column.

Parameters:

fieldIndex - 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 - The specified criteria (a string; for example, "101"). It only can be null or be one of the cells' value in this column.

public void addDateFilter(int fieldIndex, int dateTimeGroupingType, int year, int month, int day, int hour, int minute, int 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.

Parameters:

fieldIndex - 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 - A DateTimeGroupingType value. DateTimeGroupingType

year - The year.

month - The month.

day - The day.

hour - The hour.

minute - The minute.

second - The second.

public void removeDateFilter(int fieldIndex, int dateTimeGroupingType, int year, int month, int day, int hour, int minute, int 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.

Parameters:

fieldIndex - 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 - A DateTimeGroupingType value. DateTimeGroupingType

year - The year.

month - The month.

day - The day.

hour - The hour.

minute - The minute.

second - The second.

public void removeFilter(int fieldIndex, java.lang.String criteria)

Removes a filter for a filter column.

Parameters:

fieldIndex - 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 - The specified criteria (a string; for example, "101"). It only can be null or be one of the cells' value in this column.

public void filter(int fieldIndex, java.lang.String criteria)

Filters a list with specified criteria.

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

Parameters:

fieldIndex - 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 - The specified criteria (a string; for example, "101").

public void filterTop10(int fieldIndex, boolean isTop, boolean isPercent, int itemCount)

Filter the top 10 item in the list

Parameters:

fieldIndex - 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 - Indicates whether filter from top or bottom

isPercent - Indicates whether the items is percent or count

itemCount - The item count

public void dynamicFilter(int fieldIndex, int dynamicFilterType)

Adds a dynamic filter.

Parameters:

fieldIndex - 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 - A DynamicFilterType value. Dynamic filter type.

public void addFontColorFilter(int fieldIndex, CellsColor color)

Adds a font color filter.

Parameters:

fieldIndex - 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 - The CellsColor object.

public void addFillColorFilter(int fieldIndex, int pattern, CellsColor foregroundColor, CellsColor backgroundColor)

Adds a fill color filter.

Parameters:

fieldIndex - 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 - A BackgroundType value. The background pattern type.

foregroundColor - The foreground color.

backgroundColor - The background color.

public void addIconFilter(int fieldIndex, int iconSetType, int 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.

Parameters:

fieldIndex - 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 - A IconSetType value. The icon set type.

iconId - The icon id.

public void matchBlanks(int fieldIndex)

Match all blank cell in the list.

Parameters:

fieldIndex - 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).

public void matchNonBlanks(int fieldIndex)

Match all not blank cell in the list.

Parameters:

fieldIndex - 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).

public void custom(int fieldIndex, int operatorType1, java.lang.Object criteria1)

Filters a list with a custom criteria.

Parameters:

fieldIndex - 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 - A FilterOperatorType value. The filter operator type

criteria1 - The custom criteria

public void custom(int fieldIndex, int operatorType1, java.lang.Object criteria1, boolean isAnd, int operatorType2, java.lang.Object criteria2)

Filters a list with custom criteria.

Parameters:

fieldIndex - 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 - A FilterOperatorType value. The filter operator type

criteria1 - The custom criteria

isAnd -

operatorType2 - A FilterOperatorType value. The filter operator type

criteria2 - The custom criteria

public void showAll()

Unhide all rows.

public void removeFilter(int fieldIndex)

Remove the specific filter.

Parameters:

fieldIndex - The specific filter index

public int[] refresh()

Refresh auto filters to hide or unhide the rows.

Returns:

Returns all hidden rows' indexes.

public int[] refresh(boolean hideRows)

Gets all hidden rows' indexes.

Parameters:

hideRows - If true, hide the filtered rows.

Returns:

Returns all hidden rows indexes.