Foxit::PDF::TextSearch Class Reference

Class to represent text search process. More...

Public Member Functions

Boolean Release ()
 Release all resources. More...
 
Boolean FindNext ()
 Search in the direction from start to end of PDF page. More...
 
Boolean FindPrev ()
 Search in the direction from end to start of PDF page. More...
 
TextSelectionGetSelection ()
 Get a text selection object from current text search object for a found match. More...
 

Properties

Int64 pointer
 Pointer to a handle of PDF text search object. This pointer is not useful outside this SDK. The application should not access the pointer to the handle of the PDF text search object directly.
 

Detailed Description

Class to represent text search process.

In order to start a text search process, function TextPage::StartSearch should be called. Then function TextSearch::FindNext and TextSearch::FindPrev can be called to find the next or previous occurrence. Function TextSearch::GetSelection can be called to retrieve a text selection object which contains information of a found match.

Member Function Documentation

Boolean Foxit::PDF::TextSearch::FindNext ( )

Search in the direction from start to end of PDF page.

Returns
A boolean value: true means success, while false means error.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.
Boolean Foxit::PDF::TextSearch::FindPrev ( )

Search in the direction from end to start of PDF page.

Returns
A boolean value: true means success, while false means error.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.
TextSelection ^ Foxit::PDF::TextSearch::GetSelection ( )

Get a text selection object from current text search object for a found match.

Returns
A TextSelection object that receives the new PDF text selection obejct if successful.
Application should release this TextSelection object if this object is not in use, by calling function TextSelection::Release.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::Error means the function fails because of any other reasons.
ErrorCode::OutOfMemory means there is not enough memory or if the memory access is wrong.
For more error code values, please refer to enumeration Foxit::ErrorCode.
Boolean Foxit::PDF::TextSearch::Release ( )

Release all resources.

Returns
A boolean value: true means success, while false means error.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.

Foxit Corporation