Aspose::Cells::IFindOptions Class Referenceabstract

Represents find options. More...

Inherits Object.

Public Member Functions

virtual bool GetCaseSensitive ()=0
 Indicates if the searched string is case sensitive. More...
 
virtual void SetCaseSensitive (bool value)=0
 Indicates if the searched string is case sensitive. More...
 
virtual Aspose::Cells::LookAtType GetLookAtType ()=0
 Look at type. More...
 
virtual void SetLookAtType (Aspose::Cells::LookAtType value)=0
 Look at type. More...
 
virtual intrusive_ptr< Aspose::Cells::ICellAreaGetIRange ()=0
 Gets the searched range. More...
 
virtual void SetIRange (intrusive_ptr< Aspose::Cells::ICellArea > ca)=0
 Sets the searched range. More...
 
virtual bool IsRangeSet ()=0
 Indicates whether the searched range is set. More...
 
virtual bool GetSearchNext ()=0
 Search order. True: search next. False: search previous. More...
 
virtual void SetSearchNext (bool value)=0
 Search order. True: search next. False: search previous. More...
 
virtual bool GetSearchBackward ()=0
 Whether search backward for cells. More...
 
virtual void SetSearchBackward (bool value)=0
 Whether search backward for cells. More...
 
virtual bool GetSeachOrderByRows ()=0
 Indicates whether search order by rows or columns. More...
 
virtual void SetSeachOrderByRows (bool value)=0
 Indicates whether search order by rows or columns. More...
 
virtual Aspose::Cells::LookInType GetLookInType ()=0
 Look in type. More...
 
virtual void SetLookInType (Aspose::Cells::LookInType value)=0
 Look in type. More...
 
virtual bool GetRegexKey ()=0
 Indicates whether the searched key is regex. If true then the searched key will be taken as regex. More...
 
virtual void SetRegexKey (bool value)=0
 Indicates whether the searched key is regex. If true then the searched key will be taken as regex. More...
 
virtual bool GetValueTypeSensitive ()=0
 Indicates whether searched cell value type should be same with the searched key. More...
 
virtual void SetValueTypeSensitive (bool value)=0
 Indicates whether searched cell value type should be same with the searched key. More...
 
virtual intrusive_ptr< Aspose::Cells::IStyleGetIStyle ()=0
 The format to search for. More...
 
virtual void SetIStyle (intrusive_ptr< Aspose::Cells::IStyle > value)=0
 The format to search for. More...
 
virtual bool GetConvertNumericData ()=0
 Gets a value that indicates whether converting the searched string value to numeric data. More...
 
virtual void SetConvertNumericData (bool value)=0
 Sets a value that indicates whether converting the searched string value to numeric data. More...
 

Detailed Description

Represents find options.

[C++]
//Instantiate the workbook object
intrusive_ptr<Aspose::Cells::IWorkbook> workbook = Factory::CreateIWorkbook();
//Get Cells collection
intrusive_ptr<ICells> cells = workbook->GetIWorksheets()->GetObjectByIndex(0)->GetICells();
//Instantiate FindOptions Object
intrusive_ptr<IFindOptions> findOptions = Factory::CreateIFindOptions();
//Create a Cells Area
intrusive_ptr<ICellArea> ca = Factory::CreateICellArea();
ca->SetstartRow(8);
ca->SetstartColumn(2);
ca->SetendRow(17);
ca->SetendColumn(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
intrusive_ptr<ICell> cell = cells->Find(0, NULL, findOptions);

Member Function Documentation

◆ GetCaseSensitive()

virtual bool Aspose::Cells::IFindOptions::GetCaseSensitive ( )
pure virtual

Indicates if the searched string is case sensitive.

◆ GetConvertNumericData()

virtual bool Aspose::Cells::IFindOptions::GetConvertNumericData ( )
pure virtual

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

◆ GetIRange()

virtual intrusive_ptr<Aspose::Cells::ICellArea> Aspose::Cells::IFindOptions::GetIRange ( )
pure virtual

Gets the searched range.

Returns
Returns the searched range.

◆ GetIStyle()

virtual intrusive_ptr<Aspose::Cells::IStyle> Aspose::Cells::IFindOptions::GetIStyle ( )
pure virtual

The format to search for.

◆ GetLookAtType()

virtual Aspose::Cells::LookAtType Aspose::Cells::IFindOptions::GetLookAtType ( )
pure virtual

Look at type.

◆ GetLookInType()

virtual Aspose::Cells::LookInType Aspose::Cells::IFindOptions::GetLookInType ( )
pure virtual

Look in type.

◆ GetRegexKey()

virtual bool Aspose::Cells::IFindOptions::GetRegexKey ( )
pure virtual

Indicates whether the searched key is regex. If true then the searched key will be taken as regex.

◆ GetSeachOrderByRows()

virtual bool Aspose::Cells::IFindOptions::GetSeachOrderByRows ( )
pure virtual

Indicates whether search order by rows or columns.

◆ GetSearchBackward()

virtual bool Aspose::Cells::IFindOptions::GetSearchBackward ( )
pure virtual

Whether search backward for cells.

◆ GetSearchNext()

virtual bool Aspose::Cells::IFindOptions::GetSearchNext ( )
pure virtual

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

◆ GetValueTypeSensitive()

virtual bool Aspose::Cells::IFindOptions::GetValueTypeSensitive ( )
pure virtual

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

◆ IsRangeSet()

virtual bool Aspose::Cells::IFindOptions::IsRangeSet ( )
pure virtual

Indicates whether the searched range is set.

◆ SetCaseSensitive()

virtual void Aspose::Cells::IFindOptions::SetCaseSensitive ( bool  value)
pure virtual

Indicates if the searched string is case sensitive.

◆ SetConvertNumericData()

virtual void Aspose::Cells::IFindOptions::SetConvertNumericData ( bool  value)
pure virtual

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

◆ SetIRange()

virtual void Aspose::Cells::IFindOptions::SetIRange ( intrusive_ptr< Aspose::Cells::ICellArea ca)
pure virtual

Sets the searched range.

Parameters
cathe searched range.

◆ SetIStyle()

virtual void Aspose::Cells::IFindOptions::SetIStyle ( intrusive_ptr< Aspose::Cells::IStyle value)
pure virtual

The format to search for.

◆ SetLookAtType()

virtual void Aspose::Cells::IFindOptions::SetLookAtType ( Aspose::Cells::LookAtType  value)
pure virtual

Look at type.

◆ SetLookInType()

virtual void Aspose::Cells::IFindOptions::SetLookInType ( Aspose::Cells::LookInType  value)
pure virtual

Look in type.

◆ SetRegexKey()

virtual void Aspose::Cells::IFindOptions::SetRegexKey ( bool  value)
pure virtual

Indicates whether the searched key is regex. If true then the searched key will be taken as regex.

◆ SetSeachOrderByRows()

virtual void Aspose::Cells::IFindOptions::SetSeachOrderByRows ( bool  value)
pure virtual

Indicates whether search order by rows or columns.

◆ SetSearchBackward()

virtual void Aspose::Cells::IFindOptions::SetSearchBackward ( bool  value)
pure virtual

Whether search backward for cells.

◆ SetSearchNext()

virtual void Aspose::Cells::IFindOptions::SetSearchNext ( bool  value)
pure virtual

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

◆ SetValueTypeSensitive()

virtual void Aspose::Cells::IFindOptions::SetValueTypeSensitive ( bool  value)
pure virtual

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