Foxit PDF SDK

Public 成员函数 | 所有成员列表
FSDK::EmbeddedGotoTarget类 参考

## Public 成员函数
| constructor (document)
| 使用 PDF 文档构造。 更多...
| constructor (document, target_object)
| 使用 PDF 字典构造。 更多...
| GetAttachedFileName ()
| 获取嵌入式文件名，该文件名在当前目标文件的"EmbeddedFile"名称树中使用。 更多...
| GetDict ()
| 获取当前对象的 PDF 字典。 更多...
| GetFileAttachmentAnnotIndex ()
| 获取在指定页面中指定文件附件注释的注释索引。 更多...
| GetPageIndex ()
| 获取指定包含目标文件附件注释的页面的页面索引。 更多...
| GetRelationship ()
| 获取当前目标对象与当前目标对象所属对象之间的关系。 更多...
| GetTarget ()
| 获取指定到目标文档的附加路径信息的目标。 更多...
| IsEmpty ()
| 检查当前对象是否为空。 更多...
| SetAttachedFileName (embed_file_name)
| 设置嵌入式文件名，该文件名在当前目标文件的"EmbeddedFile"名称树中使用。 更多...
| SetFileAttachmentAnnotIndex (annot_index)
| 设置在指定页面中指定文件附件注释的注释索引。 更多...
| SetPageIndex (page_index)
| 设置指定包含目标文件附件注释的页面的页面索引。 更多...
| SetRelationship (relationship)
| 设置当前目标对象与当前目标对象所属对象之间的关系。 更多...
| SetTarget (target)
| 设置指定到目标文档的附加路径信息的目标。 更多...

## 详细描述

嵌入式跳转操作的目标是目标所在的文档。

参见
  FSDK.EmbeddedGotoAction

## 成员函数说明

## ◆ constructor() [1/2]

FSDK::EmbeddedGotoTarget::constructor | ( | document |  | ) |

使用 PDF 文档构造。

此构造函数用于构造一个新的嵌入式跳转目标对象（不包含任何数据）。

参数

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

## ◆ constructor() [2/2]

FSDK::EmbeddedGotoTarget::constructor | ( | document | ,
|  | target_object |
| ) |  |

使用 PDF 字典构造。

参数

  [in] | document | 有效的 PDF 文档对象。
  [in] | target_object | 表示嵌入式跳转目标数据的 PDF 字典。

## ◆ GetAttachedFileName()

FSDK::EmbeddedGotoTarget::GetAttachedFileName | ( |  | ) |

获取嵌入式文件名，该文件名在当前目标文件的"EmbeddedFile"名称树中使用。

仅当关系为"C"时才有用。如果此属性是有效字符串， 则表示目标文件是在"EmbeddedFiles"名称树中定义的嵌入式文件。

返回
  嵌入式文件名。

## ◆ GetDict()

FSDK::EmbeddedGotoTarget::GetDict | ( |  | ) |

获取当前对象的 PDF 字典。

返回
  PDF 字典。如果出现任何错误，此函数将返回 null。

## ◆ GetFileAttachmentAnnotIndex()

FSDK::EmbeddedGotoTarget::GetFileAttachmentAnnotIndex | ( |  | ) |

获取在指定页面中指定文件附件注释的注释索引。

仅当关系为"C"时才有用。如果此属性存在，则表示目标文件 与文件附件注释相关，并且此属性仅指定 指定页面中的文件附件注释。函数 FSDK.EmbeddedGotoTarget.GetPageIndex 可用于 获取指定包含目标文件附件注释的页面的页面索引。

返回
  指定文件附件注释的注释索引。有效值从 0 开始。 -1 表示没有此类属性。

## ◆ GetPageIndex()

FSDK::EmbeddedGotoTarget::GetPageIndex | ( |  | ) |

获取指定包含目标文件附件注释的页面的页面索引。

仅当关系为"C"时才有用。如果此属性存在，则表示目标文件 与文件附件注释相关。并且此属性仅指定包含 文件附件注释的页面。函数 FSDK.EmbeddedGotoTarget.GetFileAttachmentAnnotIndex 可用于获取目标文件附件注释的注释索引。

返回
  页面索引。有效值从 0 开始。-1 表示没有此类属性

## ◆ GetRelationship()

FSDK::EmbeddedGotoTarget::GetRelationship | ( |  | ) |

获取当前目标对象与当前目标对象所属对象之间的关系。

关系是当前目标对象与 当前目标对象所属对象之间的关系。目前，关系可能是以下之一：

- "P"：当前目标对象是当前目标对象所属对象的父级。
- "C"：当前目标对象是当前目标对象所属对象的子级。

返回
  关系字符串。

## ◆ GetTarget()

FSDK::EmbeddedGotoTarget::GetTarget | ( |  | ) |

获取指定到目标文档的附加路径信息的目标。

返回
  嵌入式跳转目标对象。如果对于返回的嵌入式跳转目标对象，函数 FSDK.EmbeddedGotoTarget.IsEmpty 的返回值为 true，则表示当前目标对象表示 最终目标文件。

## ◆ IsEmpty()

FSDK::EmbeddedGotoTarget::IsEmpty | ( |  | ) |

检查当前对象是否为空。

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

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

## ◆ SetAttachedFileName()

FSDK::EmbeddedGotoTarget::SetAttachedFileName | ( | embed_file_name |  | ) |

设置嵌入式文件名，该文件名在当前目标文件的"EmbeddedFile"名称树中使用。

仅当关系为"C"时才有用。如果此属性存在，则表示目标文件是 在"EmbeddedFiles"名称树中定义的嵌入式文件。

参数

  [in] | embed_file_name | 嵌入式文件的名称。

返回
  无。

## ◆ SetFileAttachmentAnnotIndex()

FSDK::EmbeddedGotoTarget::SetFileAttachmentAnnotIndex | ( | annot_index |  | ) |

设置在指定页面中指定文件附件注释的注释索引。

仅当关系为"C"时才有用。如果此属性存在，则表示目标文件 与文件附件注释相关，并且此属性仅指定 指定页面中的文件附件注释。函数 FSDK.EmbeddedGotoTarget.SetPageIndex 可用于 设置指定包含目标文件附件注释的页面的页面索引。

参数

  [in] | annot_index | 用于指定文件附件注释的注释索引。 有效范围：从 0 到（count-1）。count 表示 该指定页面中的注释数量。

返回
  无。

## ◆ SetPageIndex()

FSDK::EmbeddedGotoTarget::SetPageIndex | ( | page_index |  | ) |

设置指定包含目标文件附件注释的页面的页面索引。

仅当关系为"C"时才有用。如果此属性存在，则表示目标文件 与文件附件注释相关，并且此属性仅指定包含 文件附件注释的页面。函数 FSDK.EmbeddedGotoTarget.SetFileAttachmentAnnotIndex 可用于设置目标文件附件注释的注释索引。

参数

  [in] | page_index | 用于指定包含目标文件附件注释的页面的页面索引。 有效范围：从 0 到（count-1）。count 表示 当前目标 PDF 文件的页面数。

返回
  无。

## ◆ SetRelationship()

FSDK::EmbeddedGotoTarget::SetRelationship | ( | relationship |  | ) |

设置当前目标对象与当前目标对象所属对象之间的关系。

关系是当前目标对象与 当前目标对象所属对象之间的关系。目前，关系可能是以下之一：

- "P"：当前目标对象是当前目标对象所属对象的父级。
- "C"：当前目标对象是当前目标对象所属对象的子级。

参数

  [in] | relationship | 应该是以下字符串之一："P"、"C"。

返回
  无。

## ◆ SetTarget()

FSDK::EmbeddedGotoTarget::SetTarget | ( | target |  | ) |

设置指定到目标文档的附加路径信息的目标。

参数

  [in] | target | 嵌入式跳转目标对象。如果对于返回的嵌入式跳转目标对象，函数 FSDK.EmbeddedGotoTarget.IsEmpty 的返回值为 true，则表示当前目标对象表示 最终目标文件。

返回
  无。