Foxit PDF SDK

Public 成员函数 | 所有成员列表
foxit.pdf.actions.RemoteGotoAction类 参考
类 foxit.pdf.actions.RemoteGotoAction 继承关系图:

## Public 成员函数
| RemoteGotoAction (Action action)
| 构造函数，使用父类对象。 更多...
Destination | GetDestination ()
| 获取目标信息。 更多...
string | GetDestinationName ()
| 获取在目标PDF文件中定义的目标名称。 更多...
FileSpec | GetFileSpec ()
| 获取指定目标文件的文件规范。 更多...
Action.NewWindowFlag | GetNewWindowFlag ()
| 获取用于决定是否在新窗口中打开目标文档的标志。 更多...
void | SetDestination (Destination destination)
| 设置目标信息，用于指定在目标PDF文件中要跳转到的位置。 更多...
void | SetDestinationName (string dest_name)
| 设置目标名称。 更多...
void | SetFileSpec (FileSpec file_specification)
| 设置指定目标文件的文件规范。 更多...
void | SetNewWindowFlag (Action.NewWindowFlag flag)
| 设置用于决定是否在新窗口中打开目标文档的标志。 更多...
Public 成员函数 继承自 foxit.pdf.actions.Action
| Action (PDFDoc document, PDFDictionary action_dict)
| 构造函数，带参数。 更多...
| Action (Action action)
| 构造函数，使用另一个动作对象。 更多...
PDFDictionary | GetDict ()
| 获取当前对象的PDF字典。 更多...
PDFDoc | GetDocument ()
| 获取当前动作所属的PDF文档。 更多...
Action | GetSubAction (int index)
| 按索引获取子动作。 更多...
int | GetSubActionCount ()
| 获取子动作的数量。 更多...
Action.Type | GetType ()
| 获取动作类型。 更多...
void | InsertSubAction (int index, Action sub_action)
| 在指定索引位置插入新的子动作。 更多...
bool | IsEmpty ()
| 检查当前对象是否为空。 更多...
void | RemoveAllSubActions ()
| 移除所有子动作。 更多...
void | RemoveSubAction (int index)
| 移除指定索引的子动作。 更多...
void | SetSubAction (int index, Action sub_action)
| 按索引设置子动作。 更多...

## 额外继承的成员函数
Public 类型 继承自 foxit.pdf.actions.Action
enum | NewWindowFlag { NewWindowFlag.e_NewWindowFlagFalse = 0, NewWindowFlag.e_NewWindowFlagTrue = 1, NewWindowFlag.e_NewWindowFlagNone = 2 }
| 新窗口标志枚举。 更多...
enum | Type { Type.e_TypeUnknown = 0, Type.e_TypeGoto = 1, Type.e_TypeGoToR = 2, Type.e_TypeGoToE = 3, Type.e_TypeLaunch = 4, Type.e_TypeThread = 5, Type.e_TypeURI = 6, Type.e_TypeSound = 7, Type.e_TypeMovie = 8, Type.e_TypeHide = 9, Type.e_TypeNamed = 10, Type.e_TypeSubmitForm = 11, Type.e_TypeResetForm = 12, Type.e_TypeImportData = 13, Type.e_TypeJavaScript = 14, Type.e_TypeSetOCGState = 15, Type.e_TypeRendition = 16, Type.e_TypeTrans = 17, Type.e_TypeGoTo3DView = 18 }
| 动作类型枚举。 更多...
静态 Public 成员函数 继承自 foxit.pdf.actions.Action
static Action | Create (PDFDoc document, Action.Type action_type)
| 为指定的动作类型创建新动作。 更多...

## 详细描述

远程转到动作类似于普通转到动作，但跳转到另一个PDF文件中的目标 （非嵌入文件），而不是当前PDF文件（包含远程转到动作的文件）。
类foxit.pdf.actions.RemoteGotoAction 派生自Action ，提供用于 获取/设置远程转到动作数据的函数。 远程转到动作的目标信息可以表示为目标数组或目标名称：

- 如果目标信息是目标数组，Foxit PDF SDK使用目标对象来 表示它，可以使用RemoteGotoAction.GetDestination 获取此值。

- 如果目标信息是目标名称，Foxit PDF SDK使用字符串来表示它， 可以使用RemoteGotoAction.GetDestinationName 获取此值。 特别地，相关的目标数组在目标PDF文件中定义，而不是在当前PDF文件中。 用户可以使用类foxit.pdf.objects.PDFNameTree 中的函数从目标PDF文件检索实际的目标数组。

目标PDF文件和目标信息对于远程转到动作是必需的，因此用户应 确保通过RemoteGotoAction.SetFileSpec 和 RemoteGotoAction.SetDestination 或RemoteGotoAction.SetDestinationName 设置这两个数据，特别是对于新的远程转到动作；否则，远程转到动作将是无用的。

参见
  Action

## 构造及析构函数说明

## ◆ RemoteGotoAction()

foxit.pdf.actions.RemoteGotoAction.RemoteGotoAction | ( | Action | action | ) |
| inline

构造函数，使用父类对象。

参数

  [in] | action | 父类对象。

## 成员函数说明

## ◆ GetDestination()

Destination foxit.pdf.actions.RemoteGotoAction.GetDestination | ( |  | ) |
| inline

获取目标信息。

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

- 如果是目标对象，函数RemoteGotoAction.GetDestination 将 返回有效的目标对象。

- 如果是目标名称，函数RemoteGotoAction.GetDestinationName 将 返回有效的字符串，目标名称将在目标PDF文件中定义。

如果返回的目标对象的函数Destination.IsEmpty 的返回值 为true，且函数RemoteGotoAction.GetDestinationName 返回空字符串，则表示远程转到动作没有任何目标信息。

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

## ◆ GetDestinationName()

string foxit.pdf.actions.RemoteGotoAction.GetDestinationName | ( |  | ) |
| inline

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

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

- 如果是目标对象，函数RemoteGotoAction.GetDestination 将 返回有效的目标对象。

- 如果是目标名称，函数RemoteGotoAction.GetDestinationName 将 返回有效的字符串，目标名称将在目标PDF文件中定义。

如果返回的目标对象的函数Destination.IsEmpty 的返回值 为true，且函数RemoteGotoAction.GetDestinationName 返回空字符串，则表示远程转到动作没有任何目标信息。

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

## ◆ GetFileSpec()

FileSpec foxit.pdf.actions.RemoteGotoAction.GetFileSpec | ( |  | ) |
| inline

获取指定目标文件的文件规范。

返回
  非嵌入的文件规范对象。

## ◆ GetNewWindowFlag()

Action.NewWindowFlag foxit.pdf.actions.RemoteGotoAction.GetNewWindowFlag | ( |  | ) |
| inline

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

返回
  新窗口标志。将是以下值之一：

  - foxit.pdf.actions.Action.NewWindowFlag.e_NewWindowFlagTrue 表示在新窗口中打开目标文档。

  - foxit.pdf.actions.Action.NewWindowFlag.e_NewWindowFlagFalse 表示 目标文档在同一窗口中替换当前文档。

  - foxit.pdf.actions.Action.NewWindowFlag.e_NewWindowFlagNone 表示 没有此类标志，查看器应用程序应根据当前用户首选项行为。

## ◆ SetDestination()

void foxit.pdf.actions.RemoteGotoAction.SetDestination | ( | Destination | destination | ) |
| inline

设置目标信息，用于指定在目标PDF文件中要跳转到的位置。

参数

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

返回
  无。

## ◆ SetDestinationName()

void foxit.pdf.actions.RemoteGotoAction.SetDestinationName | ( | string | dest_name | ) |
| inline

设置目标名称。

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

参数

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

返回
  无。

## ◆ SetFileSpec()

void foxit.pdf.actions.RemoteGotoAction.SetFileSpec | ( | FileSpec | file_specification | ) |
| inline

设置指定目标文件的文件规范。

参数

  [in] | file_specification | 要设置的有效文件规范对象。此对象应属于 与当前动作相同的PDF文件。它应该表示另一个PDF文件作为 目标文件，不应表示嵌入文件。

返回
  无。

## ◆ SetNewWindowFlag()

void foxit.pdf.actions.RemoteGotoAction.SetNewWindowFlag | ( | Action.NewWindowFlag | flag | ) |
| inline

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

参数

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

返回
  无。