Foxit PDF SDK

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

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

## 额外继承的成员函数
静态 Public 成员函数 继承自 FoxitPDFSDKPython2.Action
def | Create (document, action_type)
| 为指定的动作类型创建新动作。 更多...
静态 Public 属性 继承自 FoxitPDFSDKPython2.Action
| e_NewWindowFlagFalse = _fsdk.Action_e_NewWindowFlagFalse
| "NewWindow"标志为false。
| e_NewWindowFlagNone = _fsdk.Action_e_NewWindowFlagNone
| 无"NewWindow"标志。
| e_NewWindowFlagTrue = _fsdk.Action_e_NewWindowFlagTrue
| "NewWindow"标志为true。
| e_TypeGoto = _fsdk.Action_e_TypeGoto
| 动作类型：转到动作。
| e_TypeGoTo3DView = _fsdk.Action_e_TypeGoTo3DView
| 动作类型：转到3D视图动作。
| e_TypeGoToE = _fsdk.Action_e_TypeGoToE
| 动作类型：嵌入转到动作。
| e_TypeGoToR = _fsdk.Action_e_TypeGoToR
| 动作类型：远程转到动作。
| e_TypeHide = _fsdk.Action_e_TypeHide
| 动作类型：隐藏动作。
| e_TypeImportData = _fsdk.Action_e_TypeImportData
| 动作类型：导入数据动作。
| e_TypeJavaScript = _fsdk.Action_e_TypeJavaScript
| 动作类型：JavaScript动作。
| e_TypeLaunch = _fsdk.Action_e_TypeLaunch
| 动作类型：启动动作。
| e_TypeMovie = _fsdk.Action_e_TypeMovie
| 动作类型：电影动作。
| e_TypeNamed = _fsdk.Action_e_TypeNamed
| 动作类型：命名动作。
| e_TypeRendition = _fsdk.Action_e_TypeRendition
| 动作类型：演示动作。
| e_TypeResetForm = _fsdk.Action_e_TypeResetForm
| 动作类型：重置表单动作。
| e_TypeSetOCGState = _fsdk.Action_e_TypeSetOCGState
| 动作类型：设置OCG状态动作。
| e_TypeSound = _fsdk.Action_e_TypeSound
| 动作类型：声音动作。
| e_TypeSubmitForm = _fsdk.Action_e_TypeSubmitForm
| 动作类型：提交表单动作。
| e_TypeThread = _fsdk.Action_e_TypeThread
| 动作类型：线程动作。
| e_TypeTrans = _fsdk.Action_e_TypeTrans
| 动作类型：过渡动作。
| e_TypeUnknown = _fsdk.Action_e_TypeUnknown
| 动作类型：未知动作。
| e_TypeURI = _fsdk.Action_e_TypeURI
| 动作类型：统一资源标识符(URI)动作。

## 详细描述

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

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

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

参见
  Action

## 构造及析构函数说明

## ◆ RemoteGotoAction()

def FoxitPDFSDKPython2.RemoteGotoAction.RemoteGotoAction | ( |  | action | ) |

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

参数

  [in] | action | 父类对象。

## 成员函数说明

## ◆ GetDestination()

def FoxitPDFSDKPython2.RemoteGotoAction.GetDestination | ( |  | ) |

获取目标信息。

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

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

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

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

## ◆ GetDestinationName()

def FoxitPDFSDKPython2.RemoteGotoAction.GetDestinationName | ( |  | ) |

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

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

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

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

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

## ◆ GetFileSpec()

def FoxitPDFSDKPython2.RemoteGotoAction.GetFileSpec | ( |  | ) |

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

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

## ◆ GetNewWindowFlag()

def FoxitPDFSDKPython2.RemoteGotoAction.GetNewWindowFlag | ( |  | ) |

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

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

## ◆ SetDestination()

def FoxitPDFSDKPython2.RemoteGotoAction.SetDestination | ( |  | destination | ) |

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

参数

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

返回
  无。

## ◆ SetDestinationName()

def FoxitPDFSDKPython2.RemoteGotoAction.SetDestinationName | ( |  | dest_name | ) |

设置目标名称。

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

参数

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

返回
  无。

## ◆ SetFileSpec()

def FoxitPDFSDKPython2.RemoteGotoAction.SetFileSpec | ( |  | file_specification | ) |

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

参数

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

返回
  无。

## ◆ SetNewWindowFlag()

def FoxitPDFSDKPython2.RemoteGotoAction.SetNewWindowFlag | ( |  | flag | ) |

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

参数

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

返回
  无。