在应用程序中，文档的嵌入文件被称为PDF附件。此类提供了一种比 类 FSDK.PDFNameTree 更方便的方式，用于获取/设置PDF文档的EmbeddedFiles名称树中的 嵌入文件（也称为附件文件）。
- 参见
- FSDK.PDFDoc
-
FSDK.PDFNameTree
◆ AddEmbeddedFile()
| FSDK::Attachments::AddEmbeddedFile |
( |
key |
, |
|
|
file_spec |
|
|
) |
| |
使用新键名添加嵌入附件（作为文件规范对象）。
EmbeddedFiles名称树中的所有附件都按其键排序。 添加新附件时，Foxit PDF SDK将在名称树中找到合适的位置来添加它。 成功添加后，某些旧键的索引可能会更改。
- 参数
-
| [in] | key | 新键字符串。如果这是空字符串，则输入 file_spec 的名称将用作新键。 此新键不应在当前附件对象所属的PDF文档中已存在。 |
| [in] | file_spec | 要使用新键添加的文件规范对象。它应该是有效的并且 应该已嵌入到与当前附件对象相同的PDF文档中。 |
- 返回
- true 表示成功，而 false 表示失败。
◆ AddFromFilePath()
| FSDK::Attachments::AddFromFilePath |
( |
key |
, |
|
|
file_path |
|
|
) |
| |
从指定的文件路径添加新附件，并使用新键名。
EmbeddedFiles名称树中的所有附件都按其键排序。 添加新附件时，Foxit PDF SDK将在名称树中找到合适的位置来添加它。 成功添加后，某些旧键的索引可能会更改。
- 参数
-
| [in] | key | 新键字符串。如果这是空字符串，则输入 file_spec 的名称将用作新键。 此新键不应在当前附件对象所属的PDF文档中已存在。 |
| [in] | file_path | 用于指定要嵌入到PDF文档并添加到EmbeddedFiles名称树的文件的文件路径。 |
- 返回
- true 表示成功，而 false 表示失败。
◆ constructor()
| FSDK::Attachments::constructor |
( |
doc |
, |
|
|
nametree |
|
|
) |
| |
带参数的构造函数，从PDF文档对象和EmbeddedFiles名称树（如果有）构造。
-
如果未指定名称树对象，此函数将从PDF文档构造附件对象： 如果PDF文档中存在EmbeddedFiles名称树，此函数只是构造一个与该名称树关联的附件对象； 如果PDF文档中没有这样的名称树，则构造的附件对象可用于在PDF文档中创建这样的名称树 并向该名称树添加一些嵌入文件。
-
如果指定了EmbeddedFiles名称树，此函数将从该名称树以及相关的PDF文档构造附件对象。
- 参数
-
| [in] | doc | 有效的PDF文档对象。 |
| [in] | nametree | 表示EmbeddedFiles名称树的PDF名称树对象。 如果此PDF名称树对象由默认构造函数构造且尚未设置任何值， 则意味着将从PDF文档构造附件对象；否则，请确保它属于参数 doc 指定的PDF文档。 默认值：由默认构造函数构造且未设置任何值的PDF名称树对象。 |
◆ ExtractEmbeddedFileTo()
| FSDK::Attachments::ExtractEmbeddedFileTo |
( |
key |
, |
|
|
dst_file_path |
|
|
) |
| |
提取附件并将其保存到指定的文件路径。
- 参数
-
| [in] | key | 键字符串。不应为空字符串。 |
| [in] | dst_file_path | 要将附件数据保存到的文件路径。 不应为空字符串。 |
- 返回
- true 表示成功，而 false 表示失败。
◆ GetCount()
| FSDK::Attachments::GetCount |
( |
| ) |
|
◆ GetEmbeddedFile()
| FSDK::Attachments::GetEmbeddedFile |
( |
key |
| ) |
|
获取指定键的附件（作为文件规范对象）。
- 参数
-
- 返回
- 文件规范对象。
◆ GetKey()
| FSDK::Attachments::GetKey |
( |
index |
| ) |
|
通过索引获取在EmbeddedFiles名称树中定义的附件的键。
- 参数
-
- 返回
- 键字符串。
◆ GetNameTree()
| FSDK::Attachments::GetNameTree |
( |
| ) |
|
获取EmbeddedFiles名称树。
- 返回
- EmbeddedFiles名称树。
◆ IsEmpty()
| FSDK::Attachments::IsEmpty |
( |
| ) |
|
检查当前对象是否为空。
当当前对象为空时，意味着当前对象无用。
- 返回
- true 表示当前对象为空，而 false 表示不为空。
◆ RemoveAllEmbeddedFiles()
| FSDK::Attachments::RemoveAllEmbeddedFiles |
( |
| ) |
|
删除所有附件。
- 返回
- true 表示成功，而 false 表示失败。
◆ RemoveEmbeddedFile()
| FSDK::Attachments::RemoveEmbeddedFile |
( |
key |
| ) |
|
通过键删除附件。
如果输入键在EmbeddedFiles名称树中不存在， 此函数将直接返回 true。
- 参数
-
- 返回
- true 表示成功，而 false 表示失败。
◆ SetEmbeddedFile()
| FSDK::Attachments::SetEmbeddedFile |
( |
key |
, |
|
|
file_spec |
|
|
) |
| |
为指定键设置嵌入附件（作为文件规范对象）。
- 参数
-
| [in] | key | 键字符串。不应为空字符串。 此名称应已存在于当前PDF文档中。 |
| [in] | file_spec | 要设置为键值的文件规范对象。它应该是有效的并且 应该已嵌入到与当前附件对象相同的PDF文档中。 |
- 返回
- true 表示成功，而 false 表示失败。
