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

Public 成员函数

 CombineDocumentInfo (String file_path, String password) throws com.foxit.sdk.PDFException
 构造函数,带参数。 更多...
 
 CombineDocumentInfo (PDFDoc doc)
 构造函数,带参数。 更多...
 
 CombineDocumentInfo (CombineDocumentInfo other)
 构造函数,使用另一个信息对象。 更多...
 
synchronized void delete ()
 直接清除C++相关资源。 更多...
 
boolean isEmpty ()
 检查当前对象是否为空。 更多...
 
void setBookmarkTitle (String bookmark_title) throws com.foxit.sdk.PDFException
 为合并结果文件中相关源PDF文档的根书签设置新父书签的标题。 更多...
 
void setPDFFileName (String pdf_file_name) throws com.foxit.sdk.PDFException
 设置将与其他PDF文件合并的PDF文件的名称。 更多...
 
- Public 成员函数 继承自 com.foxit.sdk.common.Base
synchronized void delete ()
 直接清除C++相关资源。 更多...
 

详细描述

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

构造及析构函数说明

◆ CombineDocumentInfo() [1/3]

com.foxit.sdk.pdf.CombineDocumentInfo.CombineDocumentInfo ( String  file_path,
String  password 
) throws com.foxit.sdk.PDFException

构造函数,带参数。

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

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

◆ CombineDocumentInfo() [2/3]

com.foxit.sdk.pdf.CombineDocumentInfo.CombineDocumentInfo ( PDFDoc  doc)

构造函数,带参数。

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

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

◆ CombineDocumentInfo() [3/3]

com.foxit.sdk.pdf.CombineDocumentInfo.CombineDocumentInfo ( CombineDocumentInfo  other)

构造函数,使用另一个信息对象。

参数
[in]other另一个信息对象。

成员函数说明

◆ delete()

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

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

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

◆ isEmpty()

boolean com.foxit.sdk.pdf.CombineDocumentInfo.isEmpty ( )

检查当前对象是否为空。

当当前对象为空时,意味着当前对象是无用的。

返回
true表示当前对象为空,false表示不为空。

◆ setBookmarkTitle()

void com.foxit.sdk.pdf.CombineDocumentInfo.setBookmarkTitle ( String  bookmark_title) throws com.foxit.sdk.PDFException

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

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

参数
[in]bookmark_title在合并结果PDF文件中使用的新父书签的标题。
返回
无。

◆ setPDFFileName()

void com.foxit.sdk.pdf.CombineDocumentInfo.setPDFFileName ( String  pdf_file_name) throws com.foxit.sdk.PDFException

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

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

参数
[in]pdf_file_name将与其他PDF文件合并的PDF文件的名称。
返回
无。