Foxit PDF SDK
foxit.pdf.SplitPDFDocCallback Class Reference

Inherits SystemIDisposable.

Public Member Functions

virtual bool NeedToPause ()
 A callback function used to pause the current splitting progress. More...
 
virtual void ProgressNotify (string before_splitting_file_name, string after_split_file_path, int split_page_count, int total_page_count)
 A callback function used to notify the current splitting progress. More...
 
virtual void ResultNotify (SplitFileResultArray result_array)
 A callback function used to notify the current split result. More...
 

Detailed Description

This class represents a callback object used to pause and notify the splitting progress during the splitting process, as well as to notify the result of the split. All the pure virtual functions in this class are used as callback functions and should be implemented by user.

Member Function Documentation

◆ NeedToPause()

bool foxit.pdf.SplitPDFDocCallback.NeedToPause ( )
inlinevirtual

A callback function used to pause the current splitting progress.

Returns
true means to pause now, while false means not to pause now.

◆ ProgressNotify()

void foxit.pdf.SplitPDFDocCallback.ProgressNotify ( string  before_splitting_file_name,
string  after_split_file_path,
int  split_page_count,
int  total_page_count 
)
inlinevirtual

A callback function used to notify the current splitting progress.

Parameters
[in]before_splitting_file_nameThe file name of the original PDF document before splitting.
[in]after_split_file_pathThe file path of the PDF document generated by splitting.
[in]split_page_countThe count of pages to be split in the current PDF document.
[in]total_page_countThe total count of pages in the current PDF documen.
Returns
None.

◆ ResultNotify()

void foxit.pdf.SplitPDFDocCallback.ResultNotify ( SplitFileResultArray  result_array)
inlinevirtual

A callback function used to notify the current split result.

Parameters
[in]result_arrayAn array of SplitFileResult objects. When the splitting is completed, the result information of each file split will be notified.
Returns
None.