Foxit PDF SDK

Public 成员函数 | 静态 Public 属性 | 所有成员列表
FSDK::AssociatedFiles类 参考

## Public 成员函数
| AssociateFile (pdf_object, file_spec)
| 将文件（由 FSDK.FileSpec 表示）与PDF字典对象关联，该对象表示批注、PDF页面或PDF文档中其他对象的字典。 更多...
| AssociateFile (graphics_object, mark_content_item_index, current_resource, property_name, file_spec)
| 将文件（由 FSDK.FileSpec 表示）与指定图形对象的标记内容项关联。 更多...
| AssociateFile (page, file_spec)
| 将文件（由 FSDK.FileSpec 表示）与PDF页面关联。 更多...
| AssociateFile (image, file_spec)
| 将文件（由 FSDK.FileSpec 表示）与图像图形对象关联。 更多...
| AssociateFile (form_xobject, file_spec)
| 将文件（由 FSDK.FileSpec 表示）与表单XObject图形对象关联。 更多...
| AssociateFile (annot, file_spec)
| 将文件（由 FSDK.FileSpec 表示）与PDF批注关联。 更多...
| constructor (pdf_doc)
| 带有PDF文档的构造函数。 更多...
| GetAssociatedFile (pdf_object, index)
| 通过索引获取指定PDF字典对象中的关联文件（由 FSDK.FileSpec 表示）。 更多...
| GetAssociatedFile (graphics_object, index)
| 通过索引获取图形对象中的关联文件。 更多...
| GetAssociatedFilesCount (pdf_object)
| 获取PDF字典对象中关联文件的数量，该对象表示批注、PDF页面或PDF文档中其他对象的字典。 更多...
| GetAssociatedFilesCount (graphics_object)
| 获取图形对象中关联文件的数量。 更多...
| IsEmpty ()
| 检查当前对象是否为空。 更多...
| RemoveAssociatedFile (pdf_object, index)
| 通过索引删除指定PDF字典对象中的关联文件（由 FSDK.FileSpec 表示）。 更多...
| RemoveAssociatedFile (graphics_object, index)
| 通过索引删除图形对象中的关联文件。 更多...

## 静态 Public 属性
static | e_RelationshipAlternative
| 关系为"Alternative"，意味着文件规范是内容的替代表示，例如音频。
static | e_RelationshipData
| 关系为"Data"，意味着文件规范表示用于派生视觉呈现的信息 - 例如用于表格或图形。
static | e_RelationshipEncryptedPayload
| 关系为"Encrypted payload"，意味着文件规范是加密的有效载荷文档， 如果PDF处理器具有解密文档所需的加密过滤器，则应向用户显示该文档。
static | e_RelationshipFormData
| 关系为"Form data"，意味着文件规范是与PDF文件中的"AcroForm"字典关联的数据。
static | e_RelationshipSchema
| 关系为"Schema"，意味着文件规范是关联对象的模式定义。
static | e_RelationshipSource
| 关系为"Source"，意味着文件规范是关联内容的原始源材料。
static | e_RelationshipSupplement
| 关系为"Supplement"，意味着文件规范表示原始源或数据的补充表示，可能更易于使用。
static | e_RelationshipUnspecified
| PDF文档与关联文件之间关系的枚举。 更多...

## 详细描述

在PDF 2.0中，定义了一个名为"关联文件"的新概念。关联文件提供了一种将其他格式的内容 与PDF文件的对象相关联并识别内容和对象之间关系的方法。这些关联文件使用文件规范字典 （称为文件规范）来指定。关联文件可以链接到PDF文档的目录、页面字典、图形对象、 结构元素、XObject、DParts、批注字典等。 特别地，与图形对象关联的文件意味着与标记内容项关联。
类 FSDK.AssociatedFiles 是用于管理关联文件的类。它提供了计数/获取PDF字典或图形对象中的 关联文件、将文件（由 FSDK.FileSpec 表示）与目录、PDF页面、图形对象、表单XObject对象、 批注对象等关联的函数。
特别地，当使用PDF文档构造关联文件对象时， 相关PDF文档的文件版本将设置为2.0。

## 成员函数说明

## ◆ AssociateFile() [1/6]

FSDK::AssociatedFiles::AssociateFile | ( | pdf_object | ,
|  | file_spec |
| ) |  |

将文件（由 FSDK.FileSpec 表示）与PDF字典对象关联，该对象表示批注、PDF页面或PDF文档中其他对象的字典。

参数

  [in] | pdf_object | 有效的PDF对象。它应该是PDF字典对象或引用PDF字典对象的PDF引用对象。
  [in] | file_spec | 要与指定PDF字典关联的文件规范对象。 不应为空字符串。

返回
  无。

## ◆ AssociateFile() [2/6]

FSDK::AssociatedFiles::AssociateFile | ( | graphics_object | ,
|  | mark_content_item_index | ,
|  | current_resource | ,
|  | property_name | ,
|  | file_spec |
| ) |  |

将文件（由 FSDK.FileSpec 表示）与指定图形对象的标记内容项关联。

参数

  [in] | graphics_object | 有效的图形对象。
  [in] | mark_content_item_index | 输入图形对象中要与指定文件规范对象关联的标记内容项的索引。有效范围： 从0到(count-1)。count 由与输入图形对象相关的标记内容的函数 FSDK.MarkedContent.GetItemCount 返回。
  [in] | current_resource | 输入图形对象所关联的PDF页面的资源字典。 这也可以是引用此类PDF字典的PDF引用对象。
  [in] | property_name | 在输入资源字典的"Properties"字典中使用的属性名称。 不应为空字符串。
  [in] | file_spec | 要与指定图形对象的指定标记内容项关联的文件规范对象。不应为空字符串。

返回
  无。

注解
  当此函数成功时，应调用函数 FSDK.GraphicsObjects.GenerateContent。 请参考函数 FSDK.GraphicsObjects.GenerateContent 了解更多详细信息。

## ◆ AssociateFile() [3/6]

FSDK::AssociatedFiles::AssociateFile | ( | page | ,
|  | file_spec |
| ) |  |

将文件（由 FSDK.FileSpec 表示）与PDF页面关联。

实际上，此函数等同于将文件与PDF页面字典关联。

参数

  [in] | page | 有效的PDF页面。
  [in] | file_spec | 要与指定PDF页面关联的文件规范对象。 不应为空字符串。

返回
  无。

## ◆ AssociateFile() [4/6]

FSDK::AssociatedFiles::AssociateFile | ( | image | ,
|  | file_spec |
| ) |  |

将文件（由 FSDK.FileSpec 表示）与图像图形对象关联。

实际上，此函数等同于将文件与图像图形对象的PDF字典关联。

参数

  [in] | image | 图像图形对象。不应为 null。
  [in] | file_spec | 要与指定图像图形对象关联的文件规范对象。 不应为空字符串。

返回
  无。

## ◆ AssociateFile() [5/6]

FSDK::AssociatedFiles::AssociateFile | ( | form_xobject | ,
|  | file_spec |
| ) |  |

将文件（由 FSDK.FileSpec 表示）与表单XObject图形对象关联。

实际上，此函数等同于将文件与表单XObject图形对象的PDF字典关联。

参数

  [in] | form_xobject | 表单XObject图形对象。不应为 null。
  [in] | file_spec | 要与指定表单XObject图形对象关联的文件规范对象。 不应为空字符串。

返回
  无。

## ◆ AssociateFile() [6/6]

FSDK::AssociatedFiles::AssociateFile | ( | annot | ,
|  | file_spec |
| ) |  |

将文件（由 FSDK.FileSpec 表示）与PDF批注关联。

实际上，此函数等同于将文件与PDF批注的PDF字典关联。

参数

  [in] | annot | 有效的PDF批注。
  [in] | file_spec | 要与指定PDF批注对象关联的文件规范对象。 不应为空字符串。

返回
  无。

## ◆ constructor()

FSDK::AssociatedFiles::constructor | ( | pdf_doc |  | ) |

带有PDF文档的构造函数。

当使用此构造函数构造关联文件对象时，输入PDF文档的文件版本将设置为2.0。

参数

  [in] | pdf_doc | 有效的PDF文档对象。

## ◆ GetAssociatedFile() [1/2]

FSDK::AssociatedFiles::GetAssociatedFile | ( | pdf_object | ,
|  | index |
| ) |  |

通过索引获取指定PDF字典对象中的关联文件（由 FSDK.FileSpec 表示）。

参数

  [in] | pdf_object | 有效的PDF对象。它应该是PDF字典对象或引用PDF字典对象的PDF引用对象。
  [in] | index | 指定PDF字典对象中关联文件的索引。 有效范围：从0到(count-1)。count 由函数 FSDK.AssociatedFiles.GetAssociatedFilesCount 使用相同参数 object 返回。

返回
  表示预期关联文件的文件规范对象。

## ◆ GetAssociatedFile() [2/2]

FSDK::AssociatedFiles::GetAssociatedFile | ( | graphics_object | ,
|  | index |
| ) |  |

通过索引获取图形对象中的关联文件。

一个或多个文件可能通过将这些部分包含在标记内容之间来与内容流中的内容部分相关联。 因此，实际上此函数是获取与图形对象相关的标记内容中的关联文件（由索引指定）。

参数

  [in] | graphics_object | 有效的PDF图形对象。
  [in] | index | 指定PDF图形对象中关联文件的索引。 有效范围：从0到(count-1)。count 由函数 FSDK.AssociatedFiles.GetAssociatedFilesCount 使用 相同参数 graphics_object 返回。

返回
  表示预期关联文件的文件规范对象。

## ◆ GetAssociatedFilesCount() [1/2]

FSDK::AssociatedFiles::GetAssociatedFilesCount | ( | pdf_object |  | ) |

获取PDF字典对象中关联文件的数量，该对象表示批注、PDF页面或PDF文档中其他对象的字典。

参数

  [in] | pdf_object | 有效的PDF对象。它应该是PDF字典对象或引用PDF字典对象的PDF引用对象。

返回
  关联文件的数量。

## ◆ GetAssociatedFilesCount() [2/2]

FSDK::AssociatedFiles::GetAssociatedFilesCount | ( | graphics_object |  | ) |

获取图形对象中关联文件的数量。

一个或多个文件可能通过将这些部分包含在标记内容之间来与内容流中的内容部分相关联。 因此，实际上此函数是计算与图形对象相关的标记内容中的关联文件。

参数

  [in] | graphics_object | 有效的PDF图形对象。

返回
  关联文件的数量。

## ◆ IsEmpty()

FSDK::AssociatedFiles::IsEmpty | ( |  | ) |

检查当前对象是否为空。

当当前对象为空时，意味着当前对象无用。

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

## ◆ RemoveAssociatedFile() [1/2]

FSDK::AssociatedFiles::RemoveAssociatedFile | ( | pdf_object | ,
|  | index |
| ) |  |

通过索引删除指定PDF字典对象中的关联文件（由 FSDK.FileSpec 表示）。

参数

  [in] | pdf_object | 有效的PDF对象。它应该是PDF字典对象或引用PDF字典对象的PDF引用对象。
  [in] | index | 指定PDF字典对象中关联文件的索引。 有效范围：从0到(count-1)。count 由函数 FSDK.AssociatedFiles.GetAssociatedFilesCount 使用相同参数 object 返回。

返回
  无。

## ◆ RemoveAssociatedFile() [2/2]

FSDK::AssociatedFiles::RemoveAssociatedFile | ( | graphics_object | ,
|  | index |
| ) |  |

通过索引删除图形对象中的关联文件。

一个或多个文件可能通过将这些部分包含在标记内容之间来与内容流中的内容部分相关联。 因此，实际上此函数是计算与图形对象相关的标记内容中的关联文件。

参数

  [in] | graphics_object | 有效的PDF图形对象。
  [in] | index | 指定PDF图形对象中关联文件的索引。 有效范围：从0到(count-1)。count 由函数 FSDK.AssociatedFiles.GetAssociatedFilesCount 使用 相同参数 graphics_object 返回。

返回
  表示预期关联文件的文件规范对象。

## 类成员变量说明

## ◆ e_RelationshipUnspecified

FSDK::AssociatedFiles::e_RelationshipUnspecified
| static

PDF文档与关联文件之间关系的枚举。

此枚举的值应单独使用。关系未知或无法用其他值描述。