This class can be used for searching and replacing text. Before using any class or methods in this module, please ensure Foxit PDF SDK has been initialized successfully by function FoxitPDFSDKPython3.Library.Initialize with a key including "AdvEdit" module.
- See also
- FoxitPDFSDKPython3.Library
◆ TextSearchReplace()
def FoxitPDFSDKPython3.TextSearchReplace.TextSearchReplace |
( |
|
doc | ) |
|
Constructor.
Constructor, with another text search replace object.
- Parameters
-
[in] | doc | A valid PDF document object to be searched or replaced. Currently, Foxit PDF SDK does not support to do the replacing for dynamic XFA document. |
This constructor is to construct a text search replace object.
- Parameters
-
[in] | other | Another text search replace object. |
◆ IsEmpty()
def FoxitPDFSDKPython3.TextSearchReplace.IsEmpty |
( |
| ) |
|
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
- Returns
- true means that current object is empty, while false means not.
◆ ReplaceNext()
def FoxitPDFSDKPython3.TextSearchReplace.ReplaceNext |
( |
|
replace_text | ) |
|
Replace next text with replacing text.
- Parameters
-
[in] | replace_text | The text to be replaced with. This should not be an empty string. |
- Returns
- true means success, while false means that keywords is not found. It will still return true if users do not want to replace.
◆ ReplacePrev()
def FoxitPDFSDKPython3.TextSearchReplace.ReplacePrev |
( |
|
replace_text | ) |
|
Replace previous text with replacing text.
- Parameters
-
[in] | replace_text | The text to be replaced with. This should not be an empty string. |
- Returns
- true means success, while false means that keywords is not found. It will still return true if users do not want to replace.
◆ SetPattern()
def FoxitPDFSDKPython3.TextSearchReplace.SetPattern |
( |
|
keywords, |
|
|
|
page_index, |
|
|
|
find_option |
|
) |
| |
Set keywords and page index to do searching and replacing.
- Parameters
-
- Returns
- true means success, while false means failure.
◆ SetReplaceCallback()
def FoxitPDFSDKPython3.TextSearchReplace.SetReplaceCallback |
( |
|
replace_callback | ) |
|
Set replacing callback function.
- Parameters
-
[in] | replace_callback | The callback object for replacing.This should be implemented by user and can be null. It means that the found text always needs to be replaced if it is null |
- Returns
- None.