foxit::pdf::CombineDocumentInfo类 参考
类 foxit::pdf::CombineDocumentInfo 继承关系图:
Public 成员函数 | |
| CombineDocumentInfo (const WString &file_path, const WString &password) | |
| 构造函数，带参数。 更多... | |
| CombineDocumentInfo (const PDFDoc &doc) | |
| 构造函数，带参数。 更多... | |
| CombineDocumentInfo (const CombineDocumentInfo &other) | |
| 构造函数，使用另一个信息对象。 更多... | |
| ~CombineDocumentInfo () | |
| 析构函数。 | |
| bool | IsEmpty () const |
| 检查当前对象是否为空。 更多... | |
| bool | operator!= (const CombineDocumentInfo &other) const |
| 不相等操作符。 更多... | |
| CombineDocumentInfo & | operator= (const CombineDocumentInfo &other) |
| 赋值操作符。 更多... | |
| bool | operator== (const CombineDocumentInfo &other) const |
| 相等操作符。 更多... | |
| void | SetBookmarkTitle (const WString &bookmark_title) |
| 为合并结果文件中相关源PDF文档的根书签设置新父书签的标题。 更多... | |
| void | SetPDFFileName (const WString &pdf_file_name) |
| 设置将与其他PDF文件合并的PDF文件的名称。 更多... | |
 Public 成员函数 继承自 foxit::Base | |
| FS_HANDLE | Handle () const |
| 获取当前对象的句柄。 更多... | |
详细描述
此类表示将与其他PDF文件合并的源PDF文件的信息。
构造及析构函数说明
◆ CombineDocumentInfo() [1/3]
| foxit::pdf::CombineDocumentInfo::CombineDocumentInfo | ( | const WString & | file_path, |
| const WString & | password | ||
| ) |
构造函数，带参数。
此构造函数不检查输入PDF文件的有效性， 检查将在函数 Combination::StartCombineDocuments 中完成。
- 参数
-
[in] file_path 要与其他PDF文件合并的PDF文件的文件路径。 [in] password 由参数file_path指定的PDF文件的所有者密码。
◆ CombineDocumentInfo() [2/3]
| foxit::pdf::CombineDocumentInfo::CombineDocumentInfo | ( | const PDFDoc & | doc | ) |
构造函数，带参数。
此构造函数不检查输入PDF文件的有效性， 检查将在函数 Combination::StartCombineDocuments 中完成。
- 参数
-
[in] doc 一个有效的PDF文档对象，表示要与其他PDF文件合并的PDF文件。 请确保输入的PDF文档对象已加载；否则当前信息对象使用时 可能会出现未知错误。
◆ CombineDocumentInfo() [3/3]
| foxit::pdf::CombineDocumentInfo::CombineDocumentInfo | ( | const CombineDocumentInfo & | other | ) |
构造函数，使用另一个信息对象。
- 参数
-
[in] other 另一个信息对象。
成员函数说明
◆ IsEmpty()
| bool foxit::pdf::CombineDocumentInfo::IsEmpty | ( | ) | const |
检查当前对象是否为空。
当当前对象为空时，意味着当前对象是无用的。
- 返回
- true表示当前对象为空，false表示不为空。
◆ operator!=()
| bool foxit::pdf::CombineDocumentInfo::operator!= | ( | const CombineDocumentInfo & | other | ) | const |
不相等操作符。
- 参数
-
[in] other 另一个信息对象。此函数将检查当前对象是否不等于这个对象。
- 返回
- true表示不相等，false表示相等。
◆ operator=()
| CombineDocumentInfo& foxit::pdf::CombineDocumentInfo::operator= | ( | const CombineDocumentInfo & | other | ) |
赋值操作符。
- 参数
-
[in] other 另一个信息对象，其值将被赋值给当前对象。
- 返回
- 对当前对象本身的引用。
◆ operator==()
| bool foxit::pdf::CombineDocumentInfo::operator== | ( | const CombineDocumentInfo & | other | ) | const |
相等操作符。
- 参数
-
[in] other 另一个信息对象。此函数将检查当前对象是否等于这个对象。
- 返回
- true表示相等，false表示不相等。
◆ SetBookmarkTitle()
| void foxit::pdf::CombineDocumentInfo::SetBookmarkTitle | ( | const WString & | bookmark_title | ) |
为合并结果文件中相关源PDF文档的根书签设置新父书签的标题。
此函数用于为合并结果文件中的新书签设置书签标题， 如果合并时使用了选项值 Combination::e_CombineDocsOptionBookmark 且相关源PDF文件有任何书签。新书签将用作父书签， 相关源PDF文档的根书签将被插入为新父书签的子节点 在合并结果PDF文件中。
如果没有设置书签标题或设置了空标题，GSDK将在 由函数 Combination::StartCombineDocuments 启动的合并过程中自动生成书签标题。
- 参数
-
[in] bookmark_title 在合并结果PDF文件中使用的新父书签的标题。
- 返回
- 无。
◆ SetPDFFileName()
| void foxit::pdf::CombineDocumentInfo::SetPDFFileName | ( | const WString & | pdf_file_name | ) |
设置将与其他PDF文件合并的PDF文件的名称。
如果使用带有文件路径参数的构造函数 CombineDocumentInfo::CombineDocumentInfo， 此函数无效。 如果合并时使用了选项值 Combination::e_CombineDocsOptionOCProperties 且要合并的PDF文件有多个图层，那么要设置的PDF文件名 将显示在合并PDF文件图层的根节点上。
- 参数
-
[in] pdf_file_name 将与其他PDF文件合并的PDF文件的名称。
- 返回
- 无。
