Foxit PDF SDK
|
Public Types | |
enum | SearchFlags { SearchFlags.e_SearchNormal = 0x00, SearchFlags.e_SearchMatchCase = 0x01, SearchFlags.e_SearchMatchWholeWord = 0x02, SearchFlags.e_SearchConsecutive = 0x04 } |
Enumeration for searching flags. More... | |
Public Member Functions | |
TextSearch (foxit.pdf.PDFDoc document, SearchCancelCallback cancel, int flags) | |
Constructor, for a PDF document. More... | |
TextSearch (foxit.addon.xfa.XFADoc xfa_document, SearchCancelCallback cancel) | |
Constructor, for a specified XFA document. More... | |
TextSearch (TextPage text_page) | |
Constructor, for a specified text page. More... | |
TextSearch (Annot annot) | |
Constructor, for a specified PDF annotation. More... | |
TextSearch (TextSearch other) | |
Constructor, with another text search object. More... | |
bool | FindNext () |
Search for next matched pattern. More... | |
bool | FindPrev () |
Search for previous matched pattern. More... | |
int | GetMatchEndCharIndex () |
Get the index of the last character of current match pattern, based on current match page. More... | |
int | GetMatchPageIndex () |
Get the page index, to which current match belongs. More... | |
RectFArray | GetMatchRects () |
Get the rectangles of current match pattern. More... | |
string | GetMatchSentence () |
Get the sentence that contains current match pattern. More... | |
int | GetMatchSentenceStartIndex () |
Get the index of the first character of current match pattern, based on the match sentence. More... | |
int | GetMatchStartCharIndex () |
Get the index of the first character of current match pattern, based on current match page. More... | |
bool | IsEmpty () |
Check whether current object is empty or not. More... | |
bool | SetEndPage (int page_index) |
Set ending page index. More... | |
bool | SetPattern (string key_words) |
Set keywords to search. More... | |
bool | SetSearchFlags (int search_flags) |
Set search flags. More... | |
bool | SetStartCharacter (int char_index) |
Set starting character index, from where the search process is to be started. More... | |
bool | SetStartPage (int page_index) |
Set starting page index. More... | |
This class can construct text search in a PDF document/an XFA document/a text page or in a PDF annotation's appearance. It offers functions to do a text search and get the searching result:
To specify the searching pattern and options, use functions TextSearch.SetPattern , TextSearch.SetStartPage , TextSearch.SetEndPage and TextSearch.SetSearchFlags .
To do the searching, use function TextSearch.FindNext or TextSearch.FindPrev .
To get the searching result, use functions GetMatchXXX().
|
strong |
Enumeration for searching flags.
Values of this enumeration can be used alone or in combination.
|
inline |
Constructor, for a PDF document.
User can set a valid SearchCancelCallback object in order to decide whether to cancel the searching process or not when the callback function in SearchCancelCallback is triggered.
[in] | document | A valid PDF document object. |
[in] | cancel | A SearchCancelCallback object which decides if the searching process needs to be canceled when the callback function is triggered. This can be null which means not to cancel the searching process. If this is not null, it should be a valid SearchCancelCallback object implemented by user. |
[in] | flags | Parsing flags used for parsing text during searching. Please refer to values starting from foxit.pdf.TextPage.TextParseFlags.e_ParseTextNormal and this can be one or combination of these values. |
|
inline |
Constructor, for a specified XFA document.
[in] | xfa_document | A valid XFA document object. It should have been loaded by function addon.xfa.XFADoc.StartLoad . |
[in] | cancel | A SearchCancelCallback object which decides if the searching process needs to be canceled when the callback function is triggered. This can be null which means not to cancel the searching process. If this is not null, it should be a valid SearchCancelCallback object implemented by user. |
|
inline |
Constructor, for a specified text page.
[in] | text_page | A text page object. |
|
inline |
Constructor, for a specified PDF annotation.
Currently, only support to search in appearance of following annotation types: free text annotation, stamp annotation, widget annotation, and line annotation.
[in] | annot | A valid annotation object. |
|
inline |
Constructor, with another text search object.
[in] | other | Another text search object. |
|
inline |
Search for next matched pattern.
|
inline |
Search for previous matched pattern.
|
inline |
Get the index of the last character of current match pattern, based on current match page.
|
inline |
Get the page index, to which current match belongs.
This function can only be used for a text search in PDF document or in XFA document.
|
inline |
Get the rectangles of current match pattern.
|
inline |
Get the sentence that contains current match pattern.
|
inline |
Get the index of the first character of current match pattern, based on the match sentence.
In a sentence, there may be more than 2 match patterns. This function can help to confirm which pattern in the sentence is just current match pattern.
|
inline |
Get the index of the first character of current match pattern, based on current match page.
|
inline |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
|
inline |
Set ending page index.
This function can only be used for a text search object which is constructed with PDFDoc object or foxit.addon.xfa.XFADoc object. For other case, this function will throw exception foxit.common.ErrorCode.e_ErrUnsupported .
If this function is not called, default value count-1 will be used as the ending page index.
[in] | page_index | Index of the page, from which the search ended. Valid range: from 0 to (count-1). count is returned by function PDFDoc.GetPageCount for PDF document or by function addon.xfa.XFADoc.GetPageCount for XFA document. |
|
inline |
Set keywords to search.
[in] | key_words | The text content to be searched. It should not be an empty string. |
|
inline |
Set search flags.
If this function is not called, default value foxit.pdf.TextSearch.SearchFlags.e_SearchNormal will be used.
[in] | search_flags | Search flags. Please refer to values starting from foxit.pdf.TextSearch.SearchFlags.e_SearchNormal and this can be one or combination of these values. |
|
inline |
Set starting character index, from where the search process is to be started.
This function can only be used for a text search object which is constructed with TextPage object or PDFDoc object. For other case, this function will throw exception foxit.common.ErrorCode.e_ErrUnsupported .
If this function is not called for a newly constructed text serach object, default value will be used as the starting character index:
0 will be used as the starting character index for first search started by functionTextSearch.FindNext .
(count-1) will be used as the starting character index for first search by function TextSearch.FindPrev .
[in] | char_index | Starting character index, from where the search process is to be started. Valid range: from 0 to (count-1). count means the count of characters in the starting page for search process. |
|
inline |
Set starting page index.
This function can only be used for a text search object which is constructed with PDFDoc object or foxit.addon.xfa.XFADoc object. For other case, this function will throw exception foxit.common.ErrorCode.e_ErrUnsupported .
If this function is not called, default value 0 will be used as the starting page index.
[in] | page_index | Index of the page, from which the search starts. Valid range: from 0 to (count-1). count is returned by function PDFDoc.GetPageCount for PDF document or by function addon.xfa.XFADoc.GetPageCount for XFA document. |