FindOptions

Inheritance: java.lang.Object

public class FindOptions

Represents find options.

Example

         //Instantiate the workbook object
         Workbook workbook = new Workbook("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.setSearchBackward(false);
 
         findOptions.setSeachOrderByRows(true);
 
         findOptions.setLookInType(LookInType.VALUES);
 
         //Find the cell with 0 value
         Cell cell = cells.find(0, null, findOptions);

Constructors

Constructor	Description
FindOptions()

Methods

Method	Description
equals(Object arg0)
getCaseSensitive()	Indicates if the searched string is case sensitive.
getClass()
getConvertNumericData()	Gets a value that indicates whether converting the searched string value to numeric data.
getLookAtType()	Look at type.
getLookInType()	Look in type.
getRange()	Gets and sets the searched range.
getRegexKey()	Indicates whether the searched key is regex.
getSeachOrderByRows()	Indicates whether search order by rows or columns.
getSearchBackward()	Whether search backward for cells.
getSearchNext()	Search order.
getSearchOrderByRows()	Indicates whether search order by rows or columns.
getStyle()	The format to search for.
getValueTypeSensitive()	Indicates whether searched cell value type should be same with the searched key.
hashCode()
isRangeSet()	Indicates whether the searched range is set.
notify()
notifyAll()
setCaseSensitive(boolean value)	Indicates if the searched string is case sensitive.
setConvertNumericData(boolean value)	Sets a value that indicates whether converting the searched string value to numeric data.
setLookAtType(int value)	Look at type.
setLookInType(int value)	Look in type.
setRange(CellArea ca)	Sets the searched range.
setRegexKey(boolean value)	Indicates whether the searched key is regex.
setSeachOrderByRows(boolean value)	Indicates whether search order by rows or columns.
setSearchBackward(boolean value)	Whether search backward for cells.
setSearchNext(boolean value)	Search order.
setSearchOrderByRows(boolean value)	Indicates whether search order by rows or columns.
setStyle(Style value)	The format to search for.
setValueTypeSensitive(boolean value)	Indicates whether searched cell value type should be same with the searched key.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

FindOptions()

public FindOptions()

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

getCaseSensitive()

public boolean getCaseSensitive()

Indicates if the searched string is case sensitive.

Returns: boolean

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getConvertNumericData()

public boolean getConvertNumericData()

Gets a value that indicates whether converting the searched string value to numeric data.

Returns: boolean

getLookAtType()

public int getLookAtType()

Look at type.

See LookAtType.

Returns: int

getLookInType()

public int getLookInType()

Look in type.

See LookInType.

Returns: int

getRange()

public CellArea getRange()

Gets and sets the searched range.

Returns: CellArea - Returns the searched range.

getRegexKey()

public boolean getRegexKey()

Indicates whether the searched key is regex. If true the searched key will be taken as regex and parsed. Otherwise the key will be parsed according to the rules in ms excel.

Returns: boolean

getSeachOrderByRows()

public boolean getSeachOrderByRows()

Indicates whether search order by rows or columns.

Remarks

NOTE: This member is now obsolete. Instead, please use FindOptions.SearchOrderByRows property. This property will be removed 12 months later since November 2018. Aspose apologizes for any inconvenience you may have experienced.

Returns: boolean

getSearchBackward()

public boolean getSearchBackward()

Whether search backward for cells.

Returns: boolean

getSearchNext()

public boolean getSearchNext()

Search order. True: search next. False: search previous.

Remarks

NOTE: This member is now obsolete. Instead, please use FindOptions.SearchBackward property. This property will be removed 12 months later since November 2018. Aspose apologizes for any inconvenience you may have experienced.

Returns: boolean

getSearchOrderByRows()

public boolean getSearchOrderByRows()

Indicates whether search order by rows or columns.

Returns: boolean

getStyle()

public Style getStyle()

The format to search for.

Returns: Style

getValueTypeSensitive()

public boolean getValueTypeSensitive()

Indicates whether searched cell value type should be same with the searched key.

Returns: boolean

hashCode()

public native int hashCode()

Returns: int

isRangeSet()

public boolean isRangeSet()

Indicates whether the searched range is set.

Returns: boolean

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setCaseSensitive(boolean value)

public void setCaseSensitive(boolean value)

Indicates if the searched string is case sensitive.

Parameters:

Parameter	Type	Description
value	boolean

setConvertNumericData(boolean value)

public void setConvertNumericData(boolean value)

Sets a value that indicates whether converting the searched string value to numeric data.

Parameters:

Parameter	Type	Description
value	boolean

setLookAtType(int value)

public void setLookAtType(int value)

Look at type.

See LookAtType.

Parameters:

Parameter	Type	Description
value	int

setLookInType(int value)

public void setLookInType(int value)

Look in type.

See LookInType.

Parameters:

Parameter	Type	Description
value	int

setRange(CellArea ca)

public void setRange(CellArea ca)

Sets the searched range.

Parameters:

Parameter	Type	Description
ca	CellArea	the searched range.

setRegexKey(boolean value)

public void setRegexKey(boolean value)

Indicates whether the searched key is regex. If true the searched key will be taken as regex and parsed. Otherwise the key will be parsed according to the rules in ms excel.

Parameters:

Parameter	Type	Description
value	boolean

setSeachOrderByRows(boolean value)

public void setSeachOrderByRows(boolean value)

Indicates whether search order by rows or columns.

Remarks

Parameters:

Parameter	Type	Description
value	boolean

setSearchBackward(boolean value)

public void setSearchBackward(boolean value)

Whether search backward for cells.

Parameters:

Parameter	Type	Description
value	boolean

setSearchNext(boolean value)

public void setSearchNext(boolean value)

Search order. True: search next. False: search previous.

Remarks

Parameters:

Parameter	Type	Description
value	boolean

setSearchOrderByRows(boolean value)

public void setSearchOrderByRows(boolean value)

Indicates whether search order by rows or columns.

Parameters:

Parameter	Type	Description
value	boolean

setStyle(Style value)

public void setStyle(Style value)

The format to search for.

Parameters:

Parameter	Type	Description
value	Style

setValueTypeSensitive(boolean value)

public void setValueTypeSensitive(boolean value)

Indicates whether searched cell value type should be same with the searched key.

Parameters:

Parameter	Type	Description
value	boolean

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

Parameter	Type	Description
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter	Type	Description
arg0	long
arg1	int