Home  Products  Purchase  Downloads  Demos  Forums  Blogs  Ticket  Wiki  API  Corporate


com.aspose.cells
Class AutoFilter

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

public class AutoFilter
extends java.lang.Object

Represents autofiltering for the specified worksheet.


Method Summary
 void customFilter(int fieldIndex, byte operator1, java.lang.String criteria1)
          Filters a list with custom criterias.
 void filter(int fieldIndex, java.lang.String criteria)
          Filters a list with specified criteria.
 void filterTop10(int fieldIndex, boolean isTop, boolean isPercent, int numOfShownItems)
          Filters the top 10 item in the list.
 void matchBlanks(int fieldIndex)
          Filters a list with the blank cells.
 void matchNonBlanks(int fieldIndex)
          Filters a list with the no_blank cells.
 void setRange(CellArea ca)
          Sets cell range of auto filter.
 void showAll()
          Shows all items.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

setRange

public void setRange(CellArea ca)
Sets cell range of auto filter.

Parameters:
ca - cell range of auto filter.
Throws:
java.lang.IllegalArgumentException - if cell range is null.
CellsException - if worksheet has bean removed.

showAll

public void showAll()
Shows all items.

Throws:
CellsException - if worksheet has bean removed.

filter

public void filter(int fieldIndex,
                   java.lang.String criteria)
Filters a list with specified 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).
criteria - The specified criteria (a string; for example, "101").
Throws:
java.lang.IllegalArgumentException - if field index of auto filter is out of range;
CellsException - if worksheet has bean removed.

matchBlanks

public void matchBlanks(int fieldIndex)
Filters a list with the blank cells.

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

matchNonBlanks

public void matchNonBlanks(int fieldIndex)
Filters a list with the no_blank cells.

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

filterTop10

public void filterTop10(int fieldIndex,
                        boolean isTop,
                        boolean isPercent,
                        int numOfShownItems)
Filters 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 - whether filter from top(true) or bottom(false).
isPercent - whether the items is percent(true) or count(false).
numOfShownItems - item count or percentage value.

customFilter

public void customFilter(int fieldIndex,
                         byte operator1,
                         java.lang.String criteria1)
Filters a list with custom criterias.

Parameters:
fieldIndex -
operator1 -
criteria1 -