|
Foxit PDF SDK
|
Public Member Functions | |
| def | FindNext () |
| Search for next matched pattern. More... | |
| def | FindPrev () |
| Search for previous matched pattern. More... | |
| def | GetMatchEndCharIndex () |
| Get the index of the last character of current match pattern, based on current match page. More... | |
| def | GetMatchPageIndex () |
| Get the page index, to which current match belongs. More... | |
| def | GetMatchRects () |
| Get the rectangles of current match pattern. More... | |
| def | GetMatchSentence () |
| Get the sentence that contains current match pattern. More... | |
| def | GetMatchSentenceEndIndex () |
| Get the index of the last character of current matched pattern, based on the matched sentence. More... | |
| def | GetMatchSentenceStartIndex () |
| Get the index of the first character of current matched pattern, based on the matched sentence. More... | |
| def | GetMatchStartCharIndex () |
| Get the index of the first character of current match pattern, based on current match page. More... | |
| def | IsEmpty () |
| Check whether current object is empty or not. More... | |
| def | SetEndPage (page_index) |
| Set ending page index. More... | |
| def | SetPattern (key_words, is_regex_search) |
| Set keywords to search. More... | |
| def | SetSearchFlags (search_flags) |
| Set search flags. More... | |
| def | SetStartCharacter (char_index) |
| Set starting character index, from where the search process is to be started. More... | |
| def | SetStartPage (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 fsdk.TextSearch.SetPattern , fsdk.TextSearch.SetStartPage , fsdk.TextSearch.SetEndPage and fsdk.TextSearch.SetSearchFlags .
To do the searching, use function fsdk.TextSearch.FindNext or fsdk.TextSearch.FindPrev .
To get the searching result, use functions GetMatchXXX().
| def fsdk.TextSearch.FindNext | ( | ) |
Search for next matched pattern.
| def fsdk.TextSearch.FindPrev | ( | ) |
Search for previous matched pattern.
| def fsdk.TextSearch.GetMatchEndCharIndex | ( | ) |
Get the index of the last character of current match pattern, based on current match page.
| def fsdk.TextSearch.GetMatchPageIndex | ( | ) |
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.
| def fsdk.TextSearch.GetMatchRects | ( | ) |
Get the rectangles of current match pattern.
| def fsdk.TextSearch.GetMatchSentence | ( | ) |
Get the sentence that contains current match pattern.
| def fsdk.TextSearch.GetMatchSentenceEndIndex | ( | ) |
Get the index of the last character of current matched pattern, based on the matched sentence.
In a sentence, there may be more than 2 matched patterns. This function, along with function , can help to confirm which pattern in the sentence is just current matched pattern.
| def fsdk.TextSearch.GetMatchSentenceStartIndex | ( | ) |
Get the index of the first character of current matched pattern, based on the matched sentence.
In a sentence, there may be more than 2 matched patterns. This function, along with function , can help to confirm which pattern in the sentence is just current matched pattern.
| def fsdk.TextSearch.GetMatchStartCharIndex | ( | ) |
Get the index of the first character of current match pattern, based on current match page.
| def fsdk.TextSearch.IsEmpty | ( | ) |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
| def fsdk.TextSearch.SetEndPage | ( | page_index | ) |
Set ending page index.
This function can only be used for a text search object which is constructed with PDFDoc object or fsdk.XFADoc object. For other case, this function will throw exception fsdk.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 fsdk.PDFDoc.GetPageCount for PDF document or by function fsdk.XFADoc.GetPageCount for XFA document. |
| def fsdk.TextSearch.SetPattern | ( | key_words, | |
| is_regex_search | |||
| ) |
Set keywords to search.
| [in] | key_words | The text content to be searched. It should not be an empty string. |
| [in] | is_regex_search | true means to enable regular expression search, while false means not. If regular expression search is enabled, the search flag set by function fsdk.TextSearch.SetSearchFlags will be ignored. Default value: false. |
| def fsdk.TextSearch.SetSearchFlags | ( | search_flags | ) |
Set search flags.
If this function is not called, default value fsdk.TextSearchE_SearchNormal will be used.
| [in] | search_flags | Search flags. Please refer to values starting from fsdk.TextSearchE_SearchNormal and this can be one or combination of these values. |
| def fsdk.TextSearch.SetStartCharacter | ( | char_index | ) |
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 fsdk.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 functionfsdk.TextSearch.FindNext .
(count-1) will be used as the starting character index for first search by function fsdk.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. |
| def fsdk.TextSearch.SetStartPage | ( | page_index | ) |
Set starting page index.
This function can only be used for a text search object which is constructed with PDFDoc object or fsdk.XFADoc object. For other case, this function will throw exception fsdk.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 fsdk.PDFDoc.GetPageCount for PDF document or by function fsdk.XFADoc.GetPageCount for XFA document. |