Foxit PDF SDK
foxit.addon.pageeditor.ReplaceCallback Class Reference

Inherits SystemIDisposable.

Public Member Functions

virtual bool NeedToReplace (string search_text, string replace_text, int current_page_index, RectFArray text_rect_array)
 A callback function to verify whether need to replace text. More...
 
virtual void Release ()
 A callback function used to release current callback object itself. More...
 

Detailed Description

This class represents a callback object for replacing. All the pure virtual functions in this class are used as callback functions and should be implemented by user.

Member Function Documentation

◆ NeedToReplace()

bool foxit.addon.pageeditor.ReplaceCallback.NeedToReplace ( string  search_text,
string  replace_text,
int  current_page_index,
RectFArray  text_rect_array 
)
inlinevirtual

A callback function to verify whether need to replace text.

Parameters
[in]search_textThe search text. It will not be empty.
[in]replace_textThe text will be replaced with. It will not be empty.
[in]current_page_indexThe current page index.Valid range: from 0 to (count-1). count is returned by function PDFDoc.GetPageCount for PDF document.
[in]text_rect_arrayThe found text rect array.
Returns
true means to replace, while false means not.

◆ Release()

void foxit.addon.pageeditor.ReplaceCallback.Release ( )
inlinevirtual

A callback function used to release current callback object itself.

Returns
None.