asposecells.api
Class FindOptions

Represents find options.

Example:

# Instantiate the workbook object
workbook = Workbook("Book2.xlsx")
# Get Cells collection 
cells = workbook.getWorksheets().get(0).getCells()
# Instantiate FindOptions Object
findOptions = FindOptions()
# Create a Cells Area
ca = 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 = cells.find(0, None, findOptions)

Constructor Summary
FindOptions()
          
 
Property Getters/Setters Summary
methodgetCaseSensitive()
methodsetCaseSensitive(value)
           Indicates if the searched string is case sensitive.
methodgetConvertNumericData()
methodsetConvertNumericData(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.
methodisRangeSet()
           Indicates whether the searched range is set.
methodgetLookAtType()
methodsetLookAtType(value)
           Look at type. The value of the property is LookAtType integer constant.
methodgetLookInType()
methodsetLookInType(value)
           Look in type. The value of the property is LookInType integer constant.
methodgetRegexKey()
methodsetRegexKey(value)
           Indicates whether the searched key is regex. If true then the searched key will be taken as regex.
methodgetSeachOrderByRows()
methodsetSeachOrderByRows(value)
           Indicates whether search order by rows or columns.
methodgetSearchBackward()
methodsetSearchBackward(value)
           Whether search backward for cells.
methodgetSearchNext()
methodsetSearchNext(value)
           Search order. True: search next. False: search previous.
methodgetStyle()
methodsetStyle(value)
           The format to search for.
methodgetValueTypeSensitive()
methodsetValueTypeSensitive(value)
           Indicates whether searched cell value type should be same with the searched key.
 
Method Summary
methodgetRange()
           Gets and sets the searched range.
methodsetRange(ca)
           Sets the searched range.
 

Constructor Detail

FindOptions

FindOptions()

Property Getters/Setters Detail

setCaseSensitive : boolean 

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 

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

getLookAtType/setLookAtType : int 

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

isRangeSet : boolean 

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

getSearchNext/setSearchNext : boolean 

boolean getSearchNext() / 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 

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

getSeachOrderByRows/setSeachOrderByRows : boolean 

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

getLookInType/setLookInType : int 

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

getRegexKey/setRegexKey : boolean 

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

getValueTypeSensitive/setValueTypeSensitive : boolean 

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

getStyle/setStyle : Style 

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

getConvertNumericData/setConvertNumericData : boolean 

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

Method Detail

getRange

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

setRange

 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.