Foxit PDF SDK
Public 类型 | 静态 Public 成员函数 | 所有成员列表
foxit::pdf::Combination类 参考
类 foxit::pdf::Combination 继承关系图:
foxit::Base

Public 类型

enum  CombineDocsOptions {
  e_CombineDocsOptionBookmark = 0x0001, e_CombineDocsOptionAcroformRename = 0x0002, e_CombineDocsOptionStructrueTree = 0x0004, e_CombineDocsOptionOutputIntents = 0x0008,
  e_CombineDocsOptionOCProperties = 0x0010, e_CombineDocsOptionMarkInfos = 0x0020, e_CombineDocsOptionPageLabels = 0x0040, e_CombineDocsOptionNames = 0x0080,
  e_CombineDocsOptionObjectStream = 0x0100, e_CombineDocsOptionDuplicateStream = 0x0200
}
 用于合并PDF文件的选项枚举。 更多...
 

静态 Public 成员函数

static common::Progressive StartCombineDocuments (const char *dest_file_path, const CombineDocumentInfoArray &document_array, uint32 options, common::PauseCallback *pause=0)
 开始合并PDF文件。 更多...
 
static common::Progressive StartCombineDocuments (const wchar_t *dest_file_path, const CombineDocumentInfoArray &document_array, uint32 options, common::PauseCallback *pause=0)
 开始合并PDF文件。 更多...
 
static common::Progressive StartCombineDocuments (foxit::common::file::WriterCallback *dest_file, const CombineDocumentInfoArray &document_array, uint32 options, foxit::common::PauseCallback *pause=0)
 开始合并PDF文件。 更多...
 

额外继承的成员函数

- Public 成员函数 继承自 foxit::Base
FS_HANDLE Handle () const
 获取当前对象的句柄。 更多...
 

详细描述

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

成员枚举类型说明

◆ CombineDocsOptions

enum foxit::pdf::Combination::CombineDocsOptions

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

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

枚举值
e_CombineDocsOptionBookmark 

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

e_CombineDocsOptionAcroformRename 

如果设置，表示同名字段将在合并结果PDF文件中重命名。

e_CombineDocsOptionStructrueTree 

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

e_CombineDocsOptionOutputIntents 

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

e_CombineDocsOptionOCProperties 

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

e_CombineDocsOptionMarkInfos 

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

e_CombineDocsOptionPageLabels 

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

e_CombineDocsOptionNames 

如果设置，表示源PDF文件的"Dests"名称树和"EmbeddedFiles"名称树将 输出到合并结果PDF文件中。

e_CombineDocsOptionObjectStream 

如果设置，表示将使用对象流来生成合并结果PDF文件，以便 减少结果文件大小。

e_CombineDocsOptionDuplicateStream 

如果设置，表示源PDF文件中的重复流对象将输出到合并结果PDF文件中。

成员函数说明

◆ StartCombineDocuments() [1/3]

static common::Progressive foxit::pdf::Combination::StartCombineDocuments ( const char *  dest_file_path,
const CombineDocumentInfoArray &  document_array,
uint32  options,
common::PauseCallback *  pause = 0 
)
static

开始合并PDF文件。

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

参数
[in]dest_file_path保存合并结果PDF文件的完整路径。这不应该是空字符串。
[in]document_array表示要合并的源PDF文件信息的信息数组。
[in]options合并PDF文档的选项。请参阅从 Combination::e_CombineDocsOptionBookmark 开始的值， 这可以是这些值中的一个或它们的组合。 0表示不使用任何选项。
[in]pause决定合并过程是否需要暂停的暂停对象。 这可以是NULL，意味着在解析过程中不暂停。 如果这不是NULL，它应该是用户实现的有效暂停对象。 默认值：NULL。
返回
一个渐进式对象。请通过函数 common::Progressive::GetRateOfProgress 检查当前进度的比率。如果比率还不是100， 调用函数 common::Progressive::Continue 继续进度，直到进度完成。

◆ StartCombineDocuments() [2/3]

static common::Progressive foxit::pdf::Combination::StartCombineDocuments ( const wchar_t *  dest_file_path,
const CombineDocumentInfoArray &  document_array,
uint32  options,
common::PauseCallback *  pause = 0 
)
static

开始合并PDF文件。

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

参数
[in]dest_file_path保存合并结果PDF文件的完整路径。这不应该是空字符串。
[in]document_array表示要合并的源PDF文件信息的信息数组。
[in]options合并PDF文档的选项。请参阅从 Combination::e_CombineDocsOptionBookmark 开始的值， 这可以是这些值中的一个或它们的组合。 0表示不使用任何选项。
[in]pause决定合并过程是否需要暂停的暂停对象。 这可以是NULL，意味着在解析过程中不暂停。 如果这不是NULL，它应该是用户实现的有效暂停对象。 默认值：NULL。
返回
一个渐进式对象。请通过函数 common::Progressive::GetRateOfProgress 检查当前进度的比率。如果比率还不是100， 调用函数 common::Progressive::Continue 继续进度，直到进度完成。

◆ StartCombineDocuments() [3/3]

static common::Progressive foxit::pdf::Combination::StartCombineDocuments ( foxit::common::file::WriterCallback *  dest_file,
const CombineDocumentInfoArray &  document_array,
uint32  options,
foxit::common::PauseCallback *  pause = 0 
)
static

开始合并PDF文件。

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

参数
[in]dest_file用户实现的 common::file::WriterCallback 对象， 用于以自定义方法存储合并结果PDF文件的数据。
[in]document_array表示要合并的源PDF文件信息的信息数组。
[in]options合并PDF文档的选项。请参阅从 Combination::e_CombineDocsOptionBookmark 开始的值， 这可以是这些值中的一个或它们的组合。 0表示不使用任何选项。
[in]pause决定合并过程是否需要暂停的暂停对象。 这可以是NULL，意味着在解析过程中不暂停。 如果这不是NULL，它应该是用户实现的有效暂停对象。 默认值：NULL。
返回
一个渐进式对象。请通过函数 common::Progressive::GetRateOfProgress 检查当前进度的比率。如果比率还不是100， 调用函数 common::Progressive::Continue 继续进度，直到进度完成。