FindOptions
Source: aspose.
Represents find options.
Methods
new FindOptions()
Example
//Instantiate the workbook object
var workbook = new aspose.cells.Workbook("Book1.xls");
//Get Cells collection
var cells = workbook.getWorksheets().get(0).getCells();
//Instantiate FindOptions Object
var findOptions = new aspose.cells.FindOptions();
//Create a Cells Area
var ca = new aspose.cells.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(aspose.cells.LookInType.VALUES);
//Find the cell with 0 value
var cell = cells.find(0, null, findOptions);
Methods
getCaseSensitive()
Indicates if the searched string is case sensitive.
getConvertNumericData()
Gets or sets a value that indicates whether converting the searched string value to numeric data.
getLookAtType()
Look at type. The value of the property is LookAtType integer constant.
getLookInType()
Look in type. The value of the property is LookInType integer constant.
getRange() → CellArea
Gets and sets the searched range.
- Returns
-
CellArea
Returns the searched range.
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.
getSeachOrderByRows()
Indicates whether search order by rows or columns.
getSearchBackward()
Whether search backward for cells.
getSearchNext()
Search order. True: search next. False: search previous. 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.
getStyle()
The format to search for.
getValueTypeSensitive()
Indicates whether searched cell value type should be same with the searched key.
isRangeSet()
Indicates whether the searched range is set.
setCaseSensitive()
Indicates if the searched string is case sensitive.
setConvertNumericData()
Gets or sets a value that indicates whether converting the searched string value to numeric data.
setLookAtType()
Look at type. The value of the property is LookAtType integer constant.
setLookInType()
Look in type. The value of the property is LookInType integer constant.
setRange(ca)
Sets the searched range.
Parameter
Name | Type | Optional | Description |
---|---|---|---|
ca |
|
the searched range. |
setRegexKey()
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.
setSeachOrderByRows()
Indicates whether search order by rows or columns.
setSearchBackward()
Whether search backward for cells.
setSearchNext()
Search order. True: search next. False: search previous. 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.
setStyle()
The format to search for.
setValueTypeSensitive()
Indicates whether searched cell value type should be same with the searched key.