类 foxit::pdf::Attachments 继承关系图:

Public 成员函数
	Attachments (const PDFDoc &doc, const objects::PDFNameTree &nametree=foxit::pdf::objects::PDFNameTree())
	构造函数，带参数。从PDF文档对象和EmbeddedFiles名称树（如果有的话）构造。更多...

	Attachments (const Attachments &other)
	构造函数，通过另一个附件对象。更多...

	~Attachments ()
	析构函数。

bool	AddEmbeddedFile (const WString &key, const FileSpec &file_spec)
	使用新键名添加嵌入附件（作为文件规范对象）。更多...

bool	AddFromFilePath (const WString &key, const wchar_t *file_path)
	使用新键名从指定文件路径添加新附件。更多...

bool	ExtractEmbeddedFileTo (const WString &key, const wchar_t *dst_file_path)
	提取附件并将其保存到指定文件路径。更多...

int	GetCount ()
	获取附件的数量。更多...

FileSpec	GetEmbeddedFile (const WString &key)
	获取指定键的附件（作为文件规范对象）。更多...

WString	GetKey (int index)
	通过索引获取EmbeddedFiles名称树中定义的附件键。更多...

objects::PDFNameTree	GetNameTree () const
	获取EmbeddedFiles名称树。更多...

bool	IsEmpty () const
	检查当前对象是否为空。更多...

bool	operator != (const Attachments &other) const
	不等操作符。更多...

Attachments &	operator= (const Attachments &other)
	赋值操作符。更多...

bool	operator== (const Attachments &other) const
	相等操作符。更多...

bool	RemoveAllEmbeddedFiles ()
	移除所有附件。更多...

bool	RemoveEmbeddedFile (const WString &key)
	通过键移除附件。更多...

bool	SetEmbeddedFile (const WString &key, const FileSpec &file_spec)
	为指定键设置嵌入附件（作为文件规范对象）。更多...

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

详细描述

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

参见: PDFDoc; objects::PDFNameTree

构造及析构函数说明

◆ Attachments() [1/2]

foxit::pdf::Attachments::Attachments	(	const PDFDoc &	doc,
		const objects::PDFNameTree &	nametree = `foxit::pdf::objects::PDFNameTree()`
	)

explicit

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

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

参数

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

◆ Attachments() [2/2]

foxit::pdf::Attachments::Attachments ( const Attachments & other )

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

参数

[in] other 另一个附件对象。

成员函数说明

◆ AddEmbeddedFile()

bool foxit::pdf::Attachments::AddEmbeddedFile	(	const WString &	key,
		const FileSpec &	file_spec
	)

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

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

参数

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

返回: true 表示成功，false 表示失败。

◆ AddFromFilePath()

bool foxit::pdf::Attachments::AddFromFilePath	(	const WString &	key,
		const wchar_t *	file_path
	)

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

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

参数

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

返回: true 表示成功，false 表示失败。

◆ ExtractEmbeddedFileTo()

bool foxit::pdf::Attachments::ExtractEmbeddedFileTo	(	const WString &	key,
		const wchar_t *	dst_file_path
	)

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

参数

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

返回: true 表示成功，false 表示失败。

◆ GetCount()

int foxit::pdf::Attachments::GetCount ( )

获取附件的数量。

返回: 附件的数量。

◆ GetEmbeddedFile()

FileSpec foxit::pdf::Attachments::GetEmbeddedFile ( const WString & key )

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

参数

[in] key 键字符串。它不应该是空字符串。

返回: 文件规范对象。

◆ GetKey()

WString foxit::pdf::Attachments::GetKey ( int index )

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

参数

[in] index 要检索的键字符串的索引。有效范围：从0到（count-1）。 count 由函数 Attachments::GetCount 返回。

返回: 键字符串。

◆ GetNameTree()

objects::PDFNameTree foxit::pdf::Attachments::GetNameTree ( ) const

获取EmbeddedFiles名称树。

返回: EmbeddedFiles名称树。

◆ IsEmpty()

bool foxit::pdf::Attachments::IsEmpty ( ) const

检查当前对象是否为空。

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

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

◆ operator !=()

bool foxit::pdf::Attachments::operator != ( const Attachments & other ) const

不等操作符。

参数

[in] other 另一个附件对象。此函数将检查当前对象是否不等于这个对象。

返回: true 表示不相等，false 表示相等。

◆ operator=()

Attachments& foxit::pdf::Attachments::operator= ( const Attachments & other )

赋值操作符。

参数

[in] other 另一个附件对象，其值将被赋给当前对象。

返回: 当前对象自身的引用。

◆ operator==()

bool foxit::pdf::Attachments::operator== ( const Attachments & other ) const

相等操作符。

参数

[in] other 另一个附件对象。此函数将检查当前对象是否等于这个对象。

返回: true 表示相等，false 表示不相等。

◆ RemoveAllEmbeddedFiles()

bool foxit::pdf::Attachments::RemoveAllEmbeddedFiles ( )

移除所有附件。

返回: true 表示成功，false 表示失败。

◆ RemoveEmbeddedFile()

bool foxit::pdf::Attachments::RemoveEmbeddedFile ( const WString & key )

通过键移除附件。

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

参数

[in] key 键字符串。这不应该是空字符串。

返回: true 表示成功，false 表示失败。

◆ SetEmbeddedFile()

bool foxit::pdf::Attachments::SetEmbeddedFile	(	const WString &	key,
		const FileSpec &	file_spec
	)

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

参数

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

返回: true 表示成功，false 表示失败。

Public 成员函数

详细描述

构造及析构函数说明

◆ Attachments() [1/2]

◆ Attachments() [2/2]

成员函数说明

◆ AddEmbeddedFile()

◆ AddFromFilePath()

◆ ExtractEmbeddedFileTo()

◆ GetCount()

◆ GetEmbeddedFile()

◆ GetKey()

◆ GetNameTree()

◆ IsEmpty()

◆ operator !=()

◆ operator=()

◆ operator==()

◆ RemoveAllEmbeddedFiles()

◆ RemoveEmbeddedFile()

◆ SetEmbeddedFile()