Foxit PDF SDK
FSDK.TextSearchReplace Class Reference

Public Member Functions

 constructor (doc)
 Constructor. More...
 
 IsEmpty ()
 Check whether current object is empty or not. More...
 
 ReplaceNext (replace_text)
 Replace next text with replacing text. More...
 
 ReplacePrev (replace_text)
 Replace previous text with replacing text. More...
 
 SetPattern (keywords, page_index, find_option)
 Set keywords and page index to do searching and replacing. More...
 
 SetReplaceCallback (replace_callback)
 Set replacing callback function. More...
 

Detailed Description

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 FSDK.Library.Initialize with a key including "AdvEdit" module.

See also
FSDK.Library

Member Function Documentation

◆ constructor()

FSDK.TextSearchReplace.constructor ( doc  )

Constructor.

Parameters
[in]docA 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.

◆ IsEmpty()

FSDK.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()

FSDK.TextSearchReplace.ReplaceNext ( replace_text  )

Replace next text with replacing text.

Parameters
[in]replace_textThe 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()

FSDK.TextSearchReplace.ReplacePrev ( replace_text  )

Replace previous text with replacing text.

Parameters
[in]replace_textThe 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()

FSDK.TextSearchReplace.SetPattern ( keywords  ,
page_index  ,
find_option   
)

Set keywords and page index to do searching and replacing.

Parameters
[in]keywordsThe text content to be replaced. It should not be an empty string.
[in]page_indexIndex of the page that will be searched and replaced.Valid range: from 0 to (count-1). count is returned by function FSDK.PDFDoc.GetPageCount for PDF document. This is only used for FSDK.TextSearchReplace.ReplacePrev and FSDK.TextSearchReplace.ReplaceNext.
[in]find_optionThe find option. It should be a valid find option object.
Returns
true means success, while false means failure.

◆ SetReplaceCallback()

FSDK.TextSearchReplace.SetReplaceCallback ( replace_callback  )

Set replacing callback function.

Parameters
[in]replace_callbackThe 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.