Foxit PDF SDK

Public 成员函数 | 所有成员列表
FSDK::EmbeddedGotoAction类 参考
类 FSDK::EmbeddedGotoAction 继承关系图:

## Public 成员函数
| constructor (action)
| 使用父类对象构造。 更多...
| GetDestination ()
| 获取指定在最终目标文件中跳转位置的目标信息。 更多...
| GetDestinationName ()
| 获取在最终目标 PDF 文件中定义的目标名称。 更多...
| GetNewWindowFlag ()
| 获取用于决定是否在新窗口中打开目标文档的标志。 更多...
| GetRootFile ()
| 获取根文件的文件规范，该根文件是目标的根文件。 更多...
| GetTarget ()
| 获取目标。 更多...
| SetDestination (destination)
| 设置指定在最终目标文件中跳转位置的目标信息。 更多...
| SetDestinationName (dest_name)
| 设置目标名称。 更多...
| SetNewWindowFlag (flag)
| 设置用于决定是否在新窗口中打开目标文档的标志。 更多...
| SetRootFile (file_specification)
| 设置根文件的文件规范，该根文件是目标的根文件。 更多...
| SetTarget (target)
| 设置目标。 更多...
Public 成员函数 继承自 FSDK::Action
| constructor (document, action_dict)
| 带参数的构造函数。 更多...
| GetDict ()
| 获取当前对象的 PDF 字典。 更多...
| GetDocument ()
| 获取当前操作所属的 PDF 文档。 更多...
| GetSubAction (index)
| 通过索引获取子操作。 更多...
| GetSubActionCount ()
| 获取子操作的数量。 更多...
| GetType ()
| 获取操作类型。 更多...
| InsertSubAction (index, sub_action)
| 将新子操作插入到索引指定的位置。 更多...
| IsEmpty ()
| 检查当前对象是否为空。 更多...
| RemoveAllSubActions ()
| 删除所有子操作。 更多...
| RemoveSubAction (index)
| 删除由索引指定的子操作。 更多...
| SetSubAction (index, sub_action)
| 通过索引设置子操作。 更多...

## 额外继承的成员函数
静态 Public 成员函数 继承自 FSDK::Action
static | Create (document, action_type)
| 为指定的操作类型创建新操作。 更多...
静态 Public 属性 继承自 FSDK::Action
static | e_NewWindowFlagFalse
| 新窗口标志的枚举。 更多...
static | e_NewWindowFlagNone
| 无"NewWindow"标志。
static | e_NewWindowFlagTrue
| "NewWindow"标志为 true。
static | e_TypeGoto
| 操作类型：跳转操作。
static | e_TypeGoTo3DView
| 操作类型：跳转到 3D 视图操作。
static | e_TypeGoToE
| 操作类型：嵌入式跳转操作。
static | e_TypeGoToR
| 操作类型：远程跳转操作。
static | e_TypeHide
| 操作类型：隐藏操作。
static | e_TypeImportData
| 操作类型：导入数据操作。
static | e_TypeJavaScript
| 操作类型：JavaScript 操作。
static | e_TypeLaunch
| 操作类型：启动操作。
static | e_TypeMovie
| 操作类型：影片操作。
static | e_TypeNamed
| 操作类型：命名操作。
static | e_TypeRendition
| 操作类型：演绎操作。
static | e_TypeResetForm
| 操作类型：重置表单操作。
static | e_TypeSetOCGState
| 操作类型：设置 OCG 状态操作。
static | e_TypeSound
| 操作类型：声音操作。
static | e_TypeSubmitForm
| 操作类型：提交表单操作。
static | e_TypeThread
| 操作类型：线程操作。
static | e_TypeTrans
| 操作类型：过渡操作。
static | e_TypeUnknown
| 操作类型的枚举。 更多...
static | e_TypeURI
| 操作类型：统一资源标识符 (URI) 操作。

## 详细描述

嵌入式跳转操作类似于远程跳转操作，但允许从嵌入在另一个 PDF 文件中的 PDF 文件跳转到或从该文件跳转。 类 FSDK.EmbeddedGotoTarget 从 FSDK.Action 派生，并 提供函数来获取/设置嵌入式跳转操作数据。

参见
  FSDK.Action

## 成员函数说明

## ◆ constructor()

FSDK::EmbeddedGotoAction::constructor | ( | action |  | ) |

使用父类对象构造。

参数

  [in] | action | 父类对象。

## ◆ GetDestination()

FSDK::EmbeddedGotoAction::GetDestination | ( |  | ) |

获取指定在最终目标文件中跳转位置的目标信息。

对于嵌入式跳转操作，目标信息可以存储为目标对象 或目标名称：

- 如果是目标对象，函数 FSDK.EmbeddedGotoAction.GetDestination 将 返回一个有效的目标对象。
- 如果是目标名称，函数 FSDK.EmbeddedGotoAction.GetDestinationName 将 返回一个有效的字符串，并且目标名称将在最终目标 PDF 文件中定义。

如果对于返回的目标对象，函数 FSDK.Destination.IsEmpty 的返回值为 true，并且函数 FSDK.EmbeddedGotoAction.GetDestinationName 返回空字符串，则表示嵌入式跳转操作没有任何目标信息。

返回
  目标对象。如果对于返回的目标对象，函数 FSDK.Destination.IsEmpty 的返回值为 true，请尝试函数 FSDK.EmbeddedGotoAction.GetDestinationName。

## ◆ GetDestinationName()

FSDK::EmbeddedGotoAction::GetDestinationName | ( |  | ) |

获取在最终目标 PDF 文件中定义的目标名称。

对于远程跳转操作，目标信息可以存储为目标对象或 目标名称：

- 如果是目标对象，函数 FSDK.EmbeddedGotoAction.GetDestination 将返回一个有效的目标对象。
- 如果是目标名称，函数 FSDK.EmbeddedGotoAction.GetDestinationName 将返回一个有效的字符串，并且目标名称将在目标 PDF 文件中定义。

如果对于返回的目标对象，函数 FSDK.Destination.IsEmpty 的返回值为 true，并且函数 FSDK.EmbeddedGotoAction.GetDestinationName 返回空字符串，则表示嵌入式跳转操作没有任何目标信息。

返回
  目标名称。如果此函数返回空字符串，请尝试函数 FSDK.EmbeddedGotoAction.GetDestination。

## ◆ GetNewWindowFlag()

FSDK::EmbeddedGotoAction::GetNewWindowFlag | ( |  | ) |

获取用于决定是否在新窗口中打开目标文档的标志。

返回
  新窗口标志。它将是以下值之一：
  - FSDK.Action.e_NewWindowFlagTrue 表示 在新窗口中打开目标文档。
  - FSDK.Action.e_NewWindowFlagFalse 表示 目标文档在同一窗口中替换当前文档。
  - FSDK.Action.e_NewWindowFlagNone 表示 没有此类标志，查看器应用程序应根据当前用户首选项进行操作。

## ◆ GetRootFile()

FSDK::EmbeddedGotoAction::GetRootFile | ( |  | ) |

获取根文件的文件规范，该根文件是目标的根文件。

返回
  非嵌入式文件规范对象。如果对于返回的文件规范对象，函数 FSDK.FileSpec.IsEmpty 的返回值为 true，则表示包含 当前嵌入式跳转操作的 PDF 文件就是目标对象的根文件。

## ◆ GetTarget()

FSDK::EmbeddedGotoAction::GetTarget | ( |  | ) |

获取目标。

返回
  嵌入式跳转目标对象。如果对于返回的嵌入式跳转目标对象，函数 FSDK.EmbeddedGotoTarget.IsEmpty 的返回值为 true，则表示没有目标。

## ◆ SetDestination()

FSDK::EmbeddedGotoAction::SetDestination | ( | destination |  | ) |

设置指定在最终目标文件中跳转位置的目标信息。

参数

  [in] | destination | 要设置的有效目标对象。

返回
  无。

## ◆ SetDestinationName()

FSDK::EmbeddedGotoAction::SetDestinationName | ( | dest_name |  | ) |

设置目标名称。

目标名称应已存在于目标 PDF 文件的"Dests"名称树中。

参数

  [in] | dest_name | 要设置的目标名称。它不应为空字符串。

返回
  无。

## ◆ SetNewWindowFlag()

FSDK::EmbeddedGotoAction::SetNewWindowFlag | ( | flag |  | ) |

设置用于决定是否在新窗口中打开目标文档的标志。

参数

  [in] | flag | 新窗口标志。它应该是以下值之一： FSDK.Action.e_NewWindowFlagTrue 表示 在新窗口中打开目标文档。 FSDK.Action.e_NewWindowFlagFalse 表示 目标文档在同一窗口中替换当前文档。 FSDK.Action.e_NewWindowFlagNone 表示 不需要此类标志，查看器应用程序应根据 当前用户首选项进行操作。

返回
  无。

## ◆ SetRootFile()

FSDK::EmbeddedGotoAction::SetRootFile | ( | file_specification |  | ) |

设置根文件的文件规范，该根文件是目标的根文件。

参数

  [in] | file_specification | 文件规范对象： 它可以由默认构造函数构造，并且不设置任何值。 在这种情况下，表示包含当前嵌入式跳转操作的 PDF 文件 也是目标的根文件。 否则，这应该是一个有效的文件规范对象，并且应表示 另一个文件，而不是嵌入式文件。文件规范对象应 与当前操作在同一个 PDF 文件中。

返回
  无。

## ◆ SetTarget()

FSDK::EmbeddedGotoAction::SetTarget | ( | target |  | ) |

设置目标。

参数

  [in] | target | 嵌入式跳转目标对象。如果由默认构造函数构造并且 未设置任何值，则表示没有目标。

返回
  无。