com.aspose.cells
Class FindOptions

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

public class FindOptions 
extends java.lang.Object

Represents find options.

Example:

//Instantiate the workbook object
Workbook workbook = new Workbook("C:\\book1.xls");

//Get Cells collection 
Cells cells = workbook.getWorksheets().get(0).getCells();

//Instantiate FindOptions Object
FindOptions findOptions = new FindOptions();

//Create a Cells Area
CellArea ca = new CellArea();
ca.StartRow = 8;
ca.StartColumn = 2;
ca.EndRow = 17;
ca.EndColumn = 13;

//Set cells area for find options
findOptions.setRange(ca);

//Set searching properties
findOptions.setSearchNext(true);

findOptions.setSeachOrderByRows(true);

findOptions.setLookInType(LookInType.VALUES);

//Find the cell with 0 value
Cell cell = cells.find(0, null, findOptions);

Constructor Summary
FindOptions()
          
 
Property Getters/Setters Summary
booleangetCaseSensitive()
voidsetCaseSensitive(boolean value)
           Indicates if the searched string is case sensitive.
voidsetCaseSensitive(boolean value)
           Indicates if the searched string is case sensitive.
booleanisRangeSet()
           Indicates whether the searched range is set.
intgetLookAtType()
voidsetLookAtType(int value)
           Look at type. The value of the property is LookAtType integer constant.
intgetLookInType()
voidsetLookInType(int value)
           Look in type. The value of the property is LookInType integer constant.
booleangetRegexKey()
voidsetRegexKey(boolean value)
           Indicates whether the searched key is regex. If true then the searched key will be taken as regex.
booleangetSeachOrderByRows()
voidsetSeachOrderByRows(boolean value)
           Indicates whether search order by rows or columns.
booleangetSearchNext()
voidsetSearchNext(boolean value)
           Search order. True: search next. False: search previous.
 
Method Summary
CellAreagetRange()
           Gets and sets the searched range.
voidsetRange(CellArea ca)
           Sets the searched range.
 

Constructor Detail

FindOptions

public FindOptions()

Property Getters/Setters Detail

setCaseSensitive

public void setCaseSensitive(boolean value)
Indicates if the searched string is case sensitive. NOTE: This member is now obsolete. Instead, please use FindOptions.CaseSensitive property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.

getCaseSensitive/setCaseSensitive

public boolean getCaseSensitive() / public void setCaseSensitive(boolean value)
Indicates if the searched string is case sensitive.

getLookAtType/setLookAtType

public int getLookAtType() / public void setLookAtType(int value)
Look at type. The value of the property is LookAtType integer constant.

isRangeSet

public boolean isRangeSet()
Indicates whether the searched range is set.

getSearchNext/setSearchNext

public boolean getSearchNext() / public void setSearchNext(boolean value)
Search order. True: search next. False: search previous.

getSeachOrderByRows/setSeachOrderByRows

public boolean getSeachOrderByRows() / public void setSeachOrderByRows(boolean value)
Indicates whether search order by rows or columns.

getLookInType/setLookInType

public int getLookInType() / public void setLookInType(int value)
Look in type. The value of the property is LookInType integer constant.

getRegexKey/setRegexKey

public boolean getRegexKey() / public void setRegexKey(boolean value)
Indicates whether the searched key is regex. If true then the searched key will be taken as regex.

Method Detail

getRange

public CellArea getRange()
Gets and sets the searched range.
Returns:
Returns the seached range.

setRange

public void setRange(CellArea ca)
Sets the searched range.
Parameters:
ca - the searched range.

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cellss Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.