Foxit PDF SDK

构造函数 | 所有成员列表
FSAssociatedFiles类 参考

消息框按钮：确定。
更多...

类 FSAssociatedFiles 继承关系图:

## 构造函数
(void) | - associateFile:file_spec:
| 将文件（由 FSFileSpec 表示）与PDF字典对象关联，该字典对象代表注释、PDF页面或PDF文档中其他对象的字典。 更多...
(void) | - associateFileWithAnnot:file_spec:
| 将文件（由 FSFileSpec 表示）与PDF注释关联。 更多...
(void) | - associateFileWithFormXObject:file_spec:
| 将文件（由 FSFileSpec 表示）与表单XObject图形对象关联。 更多...
(void) | - associateFileWithGraphicsObject:mark_content_item_index:current_resource:property_name:file_spec:
| 将文件（由 FSFileSpec 表示）与指定图形对象的标记内容项关联。 更多...
(void) | - associateFileWithImageObject:file_spec:
| 将文件（由 FSFileSpec 表示）与图像图形对象关联。 更多...
(void) | - associateFileWithPDFPage:file_spec:
| 将文件（由 FSFileSpec 表示）与PDF页面关联。 更多...
(FSFileSpec *) | - getAssociatedFile:index:
| 通过索引获取指定PDF字典对象中的关联文件（由 FSFileSpec 表示）。 更多...
(int) | - getAssociatedFilesCount:
| 获取PDF字典对象中关联文件的数量，该字典对象代表注释、PDF页面或PDF文档中其他对象的字典。 更多...
(int) | - getAssociatedFilesCountWithGraphicsObject:
| 获取图形对象中关联文件的数量。 更多...
(FSFileSpec *) | - getAssociatedFileWithGraphicsObject:index:
| 通过索引获取图形对象中的关联文件。 更多...
(id) | - initWithOther:
| 构造函数，通过另一个关联文件对象。 更多...
(id) | - initWithPdf_doc:
| 构造函数，使用PDF文档。 更多...
(BOOL) | - isEmpty
| 检查当前对象是否为空。 更多...
(void) | - removeAssociatedFile:index:
| 通过索引移除指定PDF字典对象中的关联文件（由 FSFileSpec 表示）。 更多...
(void) | - removeAssociatedFileWithGraphicsObject:index:
| 通过索引移除图形对象中的关联文件。 更多...

## 详细描述

消息框按钮：确定。

消息框按钮：确定和取消。

消息框按钮：是和否。

消息框按钮：是、否和取消。

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

## 函数文档

## ◆ associateFile:file_spec:()

- (void) associateFile: |  | (FSPDFObject*) | pdf_object
file_spec: |  | (FSFileSpec*) | file_spec

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

参数

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

返回
  无。

## ◆ associateFileWithAnnot:file_spec:()

- (void) associateFileWithAnnot: |  | (FSAnnot*) | annot
file_spec: |  | (FSFileSpec*) | file_spec

将文件（由 FSFileSpec 表示）与PDF注释关联。

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

参数

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

返回
  无。

## ◆ associateFileWithFormXObject:file_spec:()

- (void) associateFileWithFormXObject: |  | (FSFormXObject*) | form_xobject
file_spec: |  | (FSFileSpec*) | file_spec

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

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

参数

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

返回
  无。

## ◆ associateFileWithGraphicsObject:mark_content_item_index:current_resource:property_name:file_spec:()

- (void) associateFileWithGraphicsObject: |  | (FSGraphicsObject*) | graphics_object
mark_content_item_index: |  | (int) | mark_content_item_index
current_resource: |  | (FSPDFObject*) | current_resource
property_name: |  | (NSString *) | property_name
file_spec: |  | (FSFileSpec*) | file_spec

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

参数

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

返回
  无。

注解
  当此函数成功时，应调用函数 FSGraphicsObjects::generateContent。 请参考函数 FSGraphicsObjects::generateContent 了解更多详情。

## ◆ associateFileWithImageObject:file_spec:()

- (void) associateFileWithImageObject: |  | (FSImageObject*) | image
file_spec: |  | (FSFileSpec*) | file_spec

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

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

参数

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

返回
  无。

## ◆ associateFileWithPDFPage:file_spec:()

- (void) associateFileWithPDFPage: |  | (FSPDFPage*) | page
file_spec: |  | (FSFileSpec*) | file_spec

将文件（由 FSFileSpec 表示）与PDF页面关联。

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

参数

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

返回
  无。

## ◆ getAssociatedFile:index:()

- (FSFileSpec *) getAssociatedFile: |  | (FSPDFObject*) | pdf_object
index: |  | (int) | index

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

参数

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

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

## ◆ getAssociatedFilesCount:()

- (int) getAssociatedFilesCount: |  | (FSPDFObject*) | pdf_object |

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

参数

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

返回
  关联文件的数量。

## ◆ getAssociatedFilesCountWithGraphicsObject:()

- (int) getAssociatedFilesCountWithGraphicsObject: |  | (FSGraphicsObject*) | graphics_object |

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

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

参数

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

返回
  关联文件的数量。

## ◆ getAssociatedFileWithGraphicsObject:index:()

- (FSFileSpec *) getAssociatedFileWithGraphicsObject: |  | (FSGraphicsObject*) | graphics_object
index: |  | (int) | index

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

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

参数

  [in] | graphics_object | 有效的PDF图形对象。
  [in] | index | 指定PDF图形对象中关联文件的索引。 有效范围：从0到（count-1）。count 由函数 FSAssociatedFiles::getAssociatedFilesCountWithGraphicsObject: 返回， 使用相同的参数 graphics_object。

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

## ◆ initWithOther:()

- (id) initWithOther: |  | (FSAssociatedFiles*) | other |

构造函数，通过另一个关联文件对象。

参数

  [in] | other | 另一个关联文件对象。

## ◆ initWithPdf_doc:()

- (id) initWithPdf_doc: |  | (FSPDFDoc*) | pdf_doc |

构造函数，使用PDF文档。

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

参数

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

## ◆ isEmpty()

- (BOOL) isEmpty |  |  |

检查当前对象是否为空。

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

返回
  YES 表示当前对象为空，NO 表示不为空。

## ◆ removeAssociatedFile:index:()

- (void) removeAssociatedFile: |  | (FSPDFObject*) | pdf_object
index: |  | (int) | index

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

参数

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

返回
  无。

## ◆ removeAssociatedFileWithGraphicsObject:index:()

- (void) removeAssociatedFileWithGraphicsObject: |  | (FSGraphicsObject*) | graphics_object
index: |  | (int) | index

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

一个或多个文件可以通过在标记内容之间包围内容流的某些部分来与这些部分关联。 因此，实际上，此函数用于移除与图形对象相关的标记内容中的关联文件。

参数

  [in] | graphics_object | 有效的PDF图形对象。
  [in] | index | 指定PDF图形对象中关联文件的索引。 有效范围：从0到（count-1）。count 由函数 FSAssociatedFiles::getAssociatedFilesCountWithGraphicsObject: 使用 相同的参数 graphics_object 返回。

返回
  无。