Foxit PDF SDK
|
Public Member Functions | |
CombineDocumentInfo (const WString &file_path, const WString &password) | |
Constructor, with parameters. More... | |
CombineDocumentInfo (const PDFDoc &doc) | |
Constructor, with parameters. More... | |
CombineDocumentInfo (const CombineDocumentInfo &other) | |
Constructor, with another information object. More... | |
~CombineDocumentInfo () | |
Destructor. | |
bool | IsEmpty () const |
Check whether current object is empty or not. More... | |
bool | operator!= (const CombineDocumentInfo &other) const |
Not equal operator. More... | |
CombineDocumentInfo & | operator= (const CombineDocumentInfo &other) |
Assign operator. More... | |
bool | operator== (const CombineDocumentInfo &other) const |
Equal operator. More... | |
void | SetBookmarkTitle (const WString &bookmark_title) |
Set the title of a new parent bookmark for the root bookmark of related source PDF document in combined result file. More... | |
![]() | |
FS_HANDLE | Handle () const |
Get the handle of current object. More... | |
This class represents information of source PDF file which is to be combined with other PDF files.
foxit::pdf::CombineDocumentInfo::CombineDocumentInfo | ( | const WString & | file_path, |
const WString & | password | ||
) |
Constructor, with parameters.
This constructor does not check the validity of input PDF file and the check will be done in function Combination::StartCombineDocuments.
[in] | file_path | File path of a PDF file, which is to be combined with other PDF files. |
[in] | password | Owner password of PDF file which is specified by parameter file_path. |
foxit::pdf::CombineDocumentInfo::CombineDocumentInfo | ( | const PDFDoc & | doc | ) |
Constructor, with parameters.
This constructor does not check the validity of input PDF file and the check will be done in function Combination::StartCombineDocuments.
[in] | doc | A valid PDF document object which represents a PDF file to be combined with other PDF files. Please ensure input PDF document object have been loaded; otherwise unknown error may occur later when current information object is used. |
foxit::pdf::CombineDocumentInfo::CombineDocumentInfo | ( | const CombineDocumentInfo & | other | ) |
Constructor, with another information object.
[in] | other | Another information object. |
bool foxit::pdf::CombineDocumentInfo::IsEmpty | ( | ) | const |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
bool foxit::pdf::CombineDocumentInfo::operator!= | ( | const CombineDocumentInfo & | other | ) | const |
Not equal operator.
[in] | other | Another information object. This function will check if current object is not equal to this one. |
CombineDocumentInfo& foxit::pdf::CombineDocumentInfo::operator= | ( | const CombineDocumentInfo & | other | ) |
Assign operator.
[in] | other | Another information object, whose value would be assigned to current object. |
bool foxit::pdf::CombineDocumentInfo::operator== | ( | const CombineDocumentInfo & | other | ) | const |
Equal operator.
[in] | other | Another information object. This function will check if current object is equal to this one. |
void foxit::pdf::CombineDocumentInfo::SetBookmarkTitle | ( | const WString & | bookmark_title | ) |
Set the title of a new parent bookmark for the root bookmark of related source PDF document in combined result file.
This function is to set the bookmark title for a new bookmark in combined result file, if option value Combination::e_CombineDocsOptionBookmark is used for combination and related source PDF file has any bookmark. The new bookmark will be used as a parent bookmark and root bookmark of related source PDF doucment will be inserted to be the child node of the new parent bookmark in combined result PDF file.
If no bookmark title is set or an empty title is set, GSDK will generate a bookmark title automatically during combination process which is started by function Combination::StartCombineDocuments.
[in] | bookmark_title | Title of a new parent bookmark which is used in combined result PDF file. |