Foxit PDF SDK

静态 Public 成员函数 | 静态 Public 属性 | 所有成员列表
FSDK::Combination类 参考

## 静态 Public 成员函数
static | StartCombineDocuments (dest_file_path, document_array, options, pause)
| 开始合并 PDF 文件。 更多...
static | StartCombineDocuments (dest_file_path, document_array, options, pause)
| 开始合并 PDF 文件。 更多...
static | StartCombineDocuments (fdest_file, document_array, options, pause)
| 开始合并 PDF 文件。 更多...

## 静态 Public 属性
static | e_CombineDocsOptionAcroformRename
| 如果设置，表示具有相同名称的字段将在合并结果 PDF 文件中重命名。
static | e_CombineDocsOptionBookmark
| 用于合并 PDF 文件的选项枚举。 更多...
static | e_CombineDocsOptionDuplicateStream
| 如果设置，表示来自源 PDF 文件的重复流对象将输出到合并结果 PDF 文件。
static | e_CombineDocsOptionMarkInfos
| 如果设置，表示源 PDF 文件的"MarkInfo"将输出到合并结果 PDF 文件。
static | e_CombineDocsOptionNames
| 如果设置，表示源 PDF 文件的"Dests"名称树和"EmbeddedFiles"名称树将 输出到合并结果 PDF 文件。
static | e_CombineDocsOptionObjectStream
| 如果设置，表示将使用对象流来生成合并结果 PDF 文件，以便 减小结果文件大小。
static | e_CombineDocsOptionOCProperties
| 如果设置，表示源 PDF 文件的"OCProperties"将输出到合并结果 PDF 文件。
static | e_CombineDocsOptionOutputIntents
| 如果设置，表示源 PDF 文件的输出意图将输出到合并结果 PDF 文件。
static | e_CombineDocsOptionPageLabels
| 如果设置，表示源 PDF 文件的页面标签将输出到合并结果 PDF 文件。
static | e_CombineDocsOptionStructrueTree
| 如果设置，表示源 PDF 文件的结构树将输出到合并结果 PDF 文件。

## 详细描述

此类可用于将多个 PDF 文件合并为一个 PDF 文件。

## 成员函数说明

## ◆ StartCombineDocuments() [1/3]

static FSDK::Combination::StartCombineDocuments | ( | dest_file_path | ,
|  | document_array | ,
|  | options | ,
|  | pause |
| ) |  |
| static

开始合并 PDF 文件。

合并文档可能需要很长时间，因此 Foxit PDF SDK 使用渐进式过程来执行此操作。 此函数不支持合并 XFA 文档。

参数

  [in] | dest_file_path | 保存合并结果 PDF 文件的完整路径。不应为空字符串。
  [in] | document_array | 表示要合并的源 PDF 文件信息的信息数组。
  [in] | options | 合并 PDF 文档的选项。请参考从 FSDK.Combination.e_CombineDocsOptionBookmark 开始的值，这可以是这些值之一或组合。 0 表示不使用任何选项。
  [in] | pause | 决定合并过程是否需要暂停的暂停对象。 这可以是 null，表示在解析过程中不暂停。 如果不是 null，它应该是由用户实现的有效暂停对象。 默认值：null。

返回
  渐进式对象。请通过函数 FSDK.Progressive.GetRateOfProgress 检查当前进度的速率。如果速率尚未达到 100，请调用函数 FSDK.Progressive.Continue 继续进度，直到进度完成。

## ◆ StartCombineDocuments() [2/3]

static FSDK::Combination::StartCombineDocuments | ( | dest_file_path | ,
|  | document_array | ,
|  | options | ,
|  | pause |
| ) |  |
| static

开始合并 PDF 文件。

合并文档可能需要很长时间，因此 Foxit PDF SDK 使用渐进式过程来执行此操作。 此函数不支持合并 XFA 文档。

参数

  [in] | dest_file_path | 保存合并结果 PDF 文件的完整路径。不应为空字符串。
  [in] | document_array | 表示要合并的源 PDF 文件信息的信息数组。
  [in] | options | 合并 PDF 文档的选项。请参考从 FSDK.Combination.e_CombineDocsOptionBookmark 开始的值，这可以是这些值之一或组合。 0 表示不使用任何选项。
  [in] | pause | 决定合并过程是否需要暂停的暂停对象。 这可以是 null，表示在解析过程中不暂停。 如果不是 null，它应该是由用户实现的有效暂停对象。 默认值：null。

返回
  渐进式对象。请通过函数 FSDK.Progressive.GetRateOfProgress 检查当前进度的速率。如果速率尚未达到 100，请调用函数 FSDK.Progressive.Continue 继续进度，直到进度完成。

## ◆ StartCombineDocuments() [3/3]

static FSDK::Combination::StartCombineDocuments | ( | fdest_file | ,
|  | document_array | ,
|  | options | ,
|  | pause |
| ) |  |
| static

开始合并 PDF 文件。

合并文档可能需要很长时间，因此 Foxit PDF SDK 使用渐进式过程来执行此操作。 此函数不支持合并 XFA 文档。

参数

  [in] | dest_file | 由用户实现的 FSDK.FileWriterCallback 对象，用于 以自定义方法存储合并结果 PDF 文件的数据。
  [in] | document_array | 表示要合并的源 PDF 文件信息的信息数组。
  [in] | options | 合并 PDF 文档的选项。请参考从 FSDK.Combination.e_CombineDocsOptionBookmark 开始的值，这可以是这些值之一或组合。 0 表示不使用任何选项。
  [in] | pause | 决定合并过程是否需要暂停的暂停对象。 这可以是 null，表示在解析过程中不暂停。 如果不是 null，它应该是由用户实现的有效暂停对象。 默认值：null。

返回
  渐进式对象。请通过函数 FSDK.Progressive.GetRateOfProgress 检查当前进度的速率。如果速率尚未达到 100，请调用函数 FSDK.Progressive.Continue 继续进度，直到进度完成。

## 类成员变量说明

## ◆ e_CombineDocsOptionBookmark

FSDK::Combination::e_CombineDocsOptionBookmark
| static

用于合并 PDF 文件的选项枚举。

此枚举的值可以单独使用或组合使用。

如果设置，表示源 PDF 文件的书签将输出到合并结果 PDF 文件。