aspose.cells
Class FindOptions

Represents find options.

Example:

//Instantiate the workbook object
$workbook = new cells\Workbook("Book1.xls");
//Get Cells collection 
$cells = $workbook->getWorksheets()->get(0)->getCells();
//Instantiate FindOptions Object
$findOptions = new cells\FindOptions();
//Create a Cells Area
$ca = new cells\CellArea();
$ca->StartRow = 0;
$ca->StartColumn = 0;
$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(cells\LookInType::VALUES);
//Find the cell with 0 value
$cell =$cells->find("a", null, $findOptions);
echo "Found cell: ".$cell."\n";

Constructor Summary
FindOptions()
          
 
Property Getters/Setters Summary
functiongetCaseSensitive()
functionsetCaseSensitive(value)
           Indicates if the searched string is case sensitive.
functiongetConvertNumericData()
functionsetConvertNumericData(value)
           Gets or sets a value that indicates whether converting the searched string value to numeric data.
voidsetCaseSensitive(value)
           Indicates if the searched string is case sensitive.
functionisRangeSet()
           Indicates whether the searched range is set.
functiongetLookAtType()
functionsetLookAtType(value)
           Look at type. The value of the property is LookAtType integer constant.
functiongetLookInType()
functionsetLookInType(value)
           Look in type. The value of the property is LookInType integer constant.
functiongetRegexKey()
functionsetRegexKey(value)
           Indicates whether the searched key is regex. If true then the searched key will be taken as regex.
functiongetSeachOrderByRows()
functionsetSeachOrderByRows(value)
           Indicates whether search order by rows or columns.
functiongetSearchBackward()
functionsetSearchBackward(value)
           Whether search backward for cells.
functiongetSearchNext()
functionsetSearchNext(value)
           Search order. True: search next. False: search previous.
functiongetStyle()
functionsetStyle(value)
           The format to search for.
functiongetValueTypeSensitive()
functionsetValueTypeSensitive(value)
           Indicates whether searched cell value type should be same with the searched key.
 
Method Summary
functiongetRange()
           Gets and sets the searched range.
functionsetRange(ca)
           Sets the searched range.
 

Constructor Detail

FindOptions

function FindOptions()

Property Getters/Setters Detail

setCaseSensitive : boolean 

function setCaseSensitive(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 : boolean 

function getCaseSensitive() / function setCaseSensitive(value)
Indicates if the searched string is case sensitive.

getLookAtType/setLookAtType : Number 

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

isRangeSet : boolean 

function isRangeSet()
Indicates whether the searched range is set.

getSearchNext/setSearchNext : boolean 

function getSearchNext() / function setSearchNext(value)
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.

getSearchBackward/setSearchBackward : boolean 

function getSearchBackward() / function setSearchBackward(value)
Whether search backward for cells.

getSeachOrderByRows/setSeachOrderByRows : boolean 

function getSeachOrderByRows() / function setSeachOrderByRows(value)
Indicates whether search order by rows or columns.

getLookInType/setLookInType : Number 

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

getRegexKey/setRegexKey : boolean 

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

getValueTypeSensitive/setValueTypeSensitive : boolean 

function getValueTypeSensitive() / function setValueTypeSensitive(value)
Indicates whether searched cell value type should be same with the searched key.

getStyle/setStyle : Style 

function getStyle() / function setStyle(value)
The format to search for.

getConvertNumericData/setConvertNumericData : boolean 

function getConvertNumericData() / function setConvertNumericData(value)
Gets or sets a value that indicates whether converting the searched string value to numeric data.

Method Detail

getRange

function getRange()
Gets and sets the searched range.
Returns:
Returns the searched range.

setRange

function setRange(ca)
Sets the searched range.
Parameters:
ca: CellArea - 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.