Foxit PDF SDK

Public 成员函数 | 所有成员列表
FSDK::CombineDocumentInfo类 参考

## Public 成员函数
| CombineDocumentInfo (doc)
| 带参数的构造函数。 更多...
| constructor (file_path, password)
| 带参数的构造函数。 更多...
| IsEmpty ()
| 检查当前对象是否为空。 更多...
| SetBookmarkTitle (bookmark_title)
| 为合并结果文件中相关源 PDF 文档的根书签设置新父书签的标题。 更多...
| SetPDFFileName (pdf_file_name)
| 设置将与其他 PDF 文件合并的 PDF 文件的名称。 更多...

## 详细描述

此类表示将与其他 PDF 文件合并的源 PDF 文件的信息。

## 构造及析构函数说明

## ◆ CombineDocumentInfo()

FSDK::CombineDocumentInfo::CombineDocumentInfo | ( | doc |  | ) |

带参数的构造函数。

此构造函数不检查输入 PDF 文件的有效性， 检查将在函数 FSDK.Combination.StartCombineDocuments 中完成。

参数

  [in] | doc | 表示要与其他 PDF 文件合并的 PDF 文件的有效 PDF 文档对象。 请确保输入的 PDF 文档对象已加载；否则以后使用当前信息对象时可能会出现未知错误。

## 成员函数说明

## ◆ constructor()

FSDK::CombineDocumentInfo::constructor | ( | file_path | ,
|  | password |
| ) |  |

带参数的构造函数。

此构造函数不检查输入 PDF 文件的有效性， 检查将在函数 FSDK.Combination.StartCombineDocuments 中完成。

参数

  [in] | file_path | 要与其他 PDF 文件合并的 PDF 文件的文件路径。
  [in] | password | 参数 file_path 指定的 PDF 文件的所有者密码。

## ◆ IsEmpty()

FSDK::CombineDocumentInfo::IsEmpty | ( |  | ) |

检查当前对象是否为空。

When the current object is empty, that means current object is useless.

返回
  true means current object is empty, while false means not.

## ◆ SetBookmarkTitle()

FSDK::CombineDocumentInfo::SetBookmarkTitle | ( | bookmark_title |  | ) |

为合并结果文件中相关源 PDF 文档的根书签设置新父书签的标题。

此函数用于在合并结果文件中为新书签设置书签标题， 如果合并时使用了选项值 FSDK.Combination.e_CombineDocsOptionBookmark 并且相关源 PDF 文件有任何书签。新书签将用作父书签， 相关源 PDF 文档的根书签将被插入为新父书签的子节点 在合并结果 PDF 文件中。
如果未设置书签标题或设置了空标题，GSDK 将在 由函数 FSDK.Combination.StartCombineDocuments 启动的合并过程中自动生成书签标题。

参数

  [in] | bookmark_title | 在合并结果 PDF 文件中使用的新父书签的标题。

返回
  无。

## ◆ SetPDFFileName()

FSDK::CombineDocumentInfo::SetPDFFileName | ( | pdf_file_name |  | ) |

设置将与其他 PDF 文件合并的 PDF 文件的名称。

如果调用带有文件路径参数的构造函数 FSDK.CombineDocumentInfo.CombineDocumentInfo，此函数无效。 如果合并时使用了选项值 FSDK.Combination.e_CombineDocsOptionOCProperties 并且要合并的 PDF 文件有多个图层，则要设置的 PDF 文件名 将显示在合并 PDF 文件图层的根节点上。

参数

  [in] | pdf_file_name | 将与其他 PDF 文件合并的 PDF 文件的名称。

返回
  无。