com.foxit.sdk.pdf.Attachments类 参考

类 com.foxit.sdk.pdf.Attachments 继承关系图:

Public 成员函数
	Attachments (Attachments other)
	构造函数，通过另一个附件对象。 更多...
	Attachments (PDFDoc doc, PDFNameTree nametree) throws com.foxit.sdk.PDFException
	构造函数，带参数。从PDF文档对象和EmbeddedFiles名称树（如果有的话）构造。 更多...
boolean	addEmbeddedFile (String key, FileSpec file_spec) throws com.foxit.sdk.PDFException
	使用新键名添加嵌入附件（作为文件规范对象）。 更多...
boolean	addFromFilePath (String key, String file_path) throws com.foxit.sdk.PDFException
	使用新键名从指定文件路径添加新附件。 更多...
synchronized void	delete ()
	直接清除C++相关资源。 更多...
boolean	extractEmbeddedFileTo (String key, String dst_file_path) throws com.foxit.sdk.PDFException
	提取附件并将其保存到指定文件路径。 更多...
int	getCount () throws com.foxit.sdk.PDFException
	获取附件的数量。 更多...
FileSpec	getEmbeddedFile (String key) throws com.foxit.sdk.PDFException
	获取指定键的附件（作为文件规范对象）。 更多...
String	getKey (int index) throws com.foxit.sdk.PDFException
	通过索引获取EmbeddedFiles名称树中定义的附件键。 更多...
PDFNameTree	getNameTree ()
	获取EmbeddedFiles名称树。 更多...
boolean	isEmpty ()
	检查当前对象是否为空。 更多...
boolean	removeAllEmbeddedFiles () throws com.foxit.sdk.PDFException
	移除所有附件。 更多...
boolean	removeEmbeddedFile (String key) throws com.foxit.sdk.PDFException
	通过键移除附件。 更多...
boolean	setEmbeddedFile (String key, FileSpec file_spec) throws com.foxit.sdk.PDFException
	为指定键设置嵌入附件（作为文件规范对象）。 更多...

详细描述

在应用程序中，文档的嵌入文件被称为PDF附件。此类提供了一种比类 com.foxit.sdk.pdf.objects.PDFNameTree 更便捷的方式， 用于获取/设置PDF文档的EmbeddedFiles名称树中的嵌入文件（也称为附件文件）。

参见

PDFDoc

com.foxit.sdk.pdf.objects.PDFNameTree

构造及析构函数说明

Attachments() [1/2]

com.foxit.sdk.pdf.Attachments.Attachments	(	PDFDoc	doc,
		PDFNameTree	nametree
	)		throws com.foxit.sdk.PDFException

构造函数，带参数。从PDF文档对象和EmbeddedFiles名称树（如果有的话）构造。

• 如果未指定名称树对象，此函数将从PDF文档构造附件对象： 如果PDF文档中存在EmbeddedFiles名称树，此函数只是构造一个与名称树关联的附件对象； 如果PDF文档中没有这样的名称树，构造的附件对象可以用于在PDF文档中创建这样的名称树 并向名称树添加一些嵌入文件。
  
• 如果指定了EmbeddedFiles名称树，此函数将从名称树以及相关的PDF文档构造附件对象。
  

参数

[in]	doc	有效的PDF文档对象。
[in]	nametree	表示EmbeddedFiles名称树的PDF名称树对象。 如果此PDF名称树对象是通过默认构造函数构造的且未设置任何值， 这意味着附件对象将从PDF文档构造；否则，请确保它属于 参数 doc 指定的PDF文档。 默认值：通过默认构造函数构造且未设置任何值的PDF名称树对象。

Attachments() [2/2]

com.foxit.sdk.pdf.Attachments.Attachments

(

Attachments

other

)

构造函数，通过另一个附件对象。

参数

[in]

other

另一个附件对象。

成员函数说明

addEmbeddedFile()

boolean com.foxit.sdk.pdf.Attachments.addEmbeddedFile	(	String	key,
		FileSpec	file_spec
	)		throws com.foxit.sdk.PDFException

使用新键名添加嵌入附件（作为文件规范对象）。

EmbeddedFiles名称树中的所有附件都按其键排序。 当添加新附件时，Foxit PDF SDK将在名称树中找到合适的位置来添加它。 添加成功后，一些旧键的索引可能会发生变化。

参数

[in]	key	新键字符串。如果这是一个空字符串，将使用输入的 file_spec 的名称 作为新键。此新键不应该已存在于当前附件对象所属的PDF文档中。
[in]	file_spec	要用新键添加的文件规范对象。它应该是有效的， 并且应该已嵌入到与当前附件对象相同的PDF文档中。

返回

true 表示成功，false 表示失败。

addFromFilePath()

boolean com.foxit.sdk.pdf.Attachments.addFromFilePath	(	String	key,
		String	file_path
	)		throws com.foxit.sdk.PDFException

使用新键名从指定文件路径添加新附件。

EmbeddedFiles名称树中的所有附件都按其键排序。 当添加新附件时，Foxit PDF SDK将在名称树中找到合适的位置来添加它。 添加成功后，一些旧键的索引可能会发生变化。

参数

[in]	key	新键字符串。如果这是一个空字符串，将使用输入的 file_spec 的名称 作为新键。此新键不应该已存在于当前附件对象所属的PDF文档中。
[in]	file_path	指定要嵌入到PDF文档并添加到EmbeddedFiles名称树的文件的文件路径。

返回

true 表示成功，false 表示失败。

delete()

synchronized void com.foxit.sdk.pdf.Attachments.delete

(

)

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

返回

无。

注解

一旦这个接口被调用，这个对象将不能再被使用。

重载 com.foxit.sdk.common.Base .

extractEmbeddedFileTo()

boolean com.foxit.sdk.pdf.Attachments.extractEmbeddedFileTo	(	String	key,
		String	dst_file_path
	)		throws com.foxit.sdk.PDFException

提取附件并将其保存到指定文件路径。

参数

[in]	key	键字符串。这不应该是空字符串。
[in]	dst_file_path	文件路径，附件数据将保存到此路径。 这不应该是空字符串。

返回

true 表示成功，false 表示失败。

getCount()

int com.foxit.sdk.pdf.Attachments.getCount

(

)

throws com.foxit.sdk.PDFException

获取附件的数量。

返回

附件的数量。

getEmbeddedFile()

FileSpec com.foxit.sdk.pdf.Attachments.getEmbeddedFile

(

String

key

)

throws com.foxit.sdk.PDFException

获取指定键的附件（作为文件规范对象）。

参数

[in]

key

键字符串。它不应该是空字符串。

返回

文件规范对象。

getKey()

String com.foxit.sdk.pdf.Attachments.getKey

(

int

index

)

throws com.foxit.sdk.PDFException

通过索引获取EmbeddedFiles名称树中定义的附件键。

参数

[in]

index

要检索的键字符串的索引。有效范围：从0到（count-1）。 count 由函数 Attachments.getCount 返回。

返回

键字符串。

getNameTree()

PDFNameTree com.foxit.sdk.pdf.Attachments.getNameTree

(

)

获取EmbeddedFiles名称树。

返回

EmbeddedFiles名称树。

isEmpty()

boolean com.foxit.sdk.pdf.Attachments.isEmpty

(

)

检查当前对象是否为空。

当前对象为空时，表示当前对象是无用的。

返回

true 表示当前对象为空，false 表示不为空。

removeAllEmbeddedFiles()

boolean com.foxit.sdk.pdf.Attachments.removeAllEmbeddedFiles

(

)

throws com.foxit.sdk.PDFException

移除所有附件。

返回

true 表示成功，false 表示失败。

removeEmbeddedFile()

boolean com.foxit.sdk.pdf.Attachments.removeEmbeddedFile

(

String

key

)

throws com.foxit.sdk.PDFException

通过键移除附件。

如果输入键在EmbeddedFiles名称树中不存在， 此函数将直接返回 true。

参数

[in]

key

键字符串。这不应该是空字符串。

返回

true 表示成功，false 表示失败。

setEmbeddedFile()

boolean com.foxit.sdk.pdf.Attachments.setEmbeddedFile	(	String	key,
		FileSpec	file_spec
	)		throws com.foxit.sdk.PDFException

为指定键设置嵌入附件（作为文件规范对象）。

参数

[in]	key	键字符串。它不应该是空字符串。 此名称应该已存在于当前PDF文档中。
[in]	file_spec	要设置为键值的文件规范对象。它应该是有效的， 并且应该已嵌入到与当前附件对象相同的PDF文档中。

返回

true 表示成功，false 表示失败。