Foxit PDF SDK
com.foxit.sdk.pdf.Combination类 参考
类 com.foxit.sdk.pdf.Combination 继承关系图:
com.foxit.sdk.common.Base

Public 成员函数

synchronized void delete ()
 直接清除C++相关资源。 更多...
 
- Public 成员函数 继承自 com.foxit.sdk.common.Base
synchronized void delete ()
 直接清除C++相关资源。 更多...
 

静态 Public 成员函数

static Progressive startCombineDocuments (String dest_file_path, CombineDocumentInfoArray document_array, int options, PauseCallback pause) throws com.foxit.sdk.PDFException
 开始合并PDF文件。 更多...
 
static Progressive startCombineDocuments (FileWriterCallback dest_file, CombineDocumentInfoArray document_array, int options, PauseCallback pause) throws com.foxit.sdk.PDFException
 开始合并PDF文件。 更多...
 

静态 Public 属性

static final int e_CombineDocsOptionAcroformRename = 0x0002
 如果设置,表示同名字段将在合并结果PDF文件中重命名。
 
static final int e_CombineDocsOptionBookmark = 0x0001
 如果设置,表示源PDF文件的书签将输出到合并结果PDF文件中。
 
static final int e_CombineDocsOptionDuplicateStream = 0x0200
 如果设置,表示源PDF文件中的重复流对象将输出到合并结果PDF文件中。
 
static final int e_CombineDocsOptionMarkInfos = 0x0020
 如果设置,表示源PDF文件的"MarkInfo"将输出到合并结果PDF文件中。
 
static final int e_CombineDocsOptionNames = 0x0080
 如果设置,表示源PDF文件的"Dests"名称树和"EmbeddedFiles"名称树将 输出到合并结果PDF文件中。
 
static final int e_CombineDocsOptionObjectStream = 0x0100
 如果设置,表示将使用对象流来生成合并结果PDF文件,以便 减少结果文件大小。
 
static final int e_CombineDocsOptionOCProperties = 0x0010
 如果设置,表示源PDF文件的"OCProperties"将输出到合并结果PDF文件中。
 
static final int e_CombineDocsOptionOutputIntents = 0x0008
 如果设置,表示源PDF文件的输出意图将输出到合并结果PDF文件中。
 
static final int e_CombineDocsOptionPageLabels = 0x0040
 如果设置,表示源PDF文件的页面标签将输出到合并结果PDF文件中。
 
static final int e_CombineDocsOptionStructrueTree = 0x0004
 如果设置,表示源PDF文件的结构树将输出到合并结果PDF文件中。
 

详细描述

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

成员函数说明

◆ delete()

synchronized void com.foxit.sdk.pdf.Combination.delete ( )

直接清除C++相关资源。

返回
无。
注解
一旦这个接口被调用,这个对象将不能再被使用。

◆ startCombineDocuments() [1/2]

static Progressive com.foxit.sdk.pdf.Combination.startCombineDocuments ( String  dest_file_path,
CombineDocumentInfoArray  document_array,
int  options,
PauseCallback  pause 
) throws com.foxit.sdk.PDFException
static

开始合并PDF文件。

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

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

◆ startCombineDocuments() [2/2]

static Progressive com.foxit.sdk.pdf.Combination.startCombineDocuments ( FileWriterCallback  dest_file,
CombineDocumentInfoArray  document_array,
int  options,
PauseCallback  pause 
) throws com.foxit.sdk.PDFException
static

开始合并PDF文件。

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

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