Foxit PDF SDK

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

## Public 成员函数
def | EmbeddedGotoAction (action)
| 构造函数，使用父类对象。 更多...
def | GetDestination ()
| 获取指定在最终目标文件中跳转位置的目标信息。 更多...
def | GetDestinationName ()
| 获取在最终目标PDF文件中定义的目标名称。 更多...
def | GetNewWindowFlag ()
| 获取用于决定是否在新窗口中打开目标文档的标志。 更多...
def | GetRootFile ()
| 获取根文件的文件规范，该根文件是目标的根文件。 更多...
def | GetTarget ()
| 获取目标。 更多...
def | SetDestination (destination)
| 设置指定在最终目标文件中跳转位置的目标信息。 更多...
def | SetDestinationName (dest_name)
| 设置目标名称。 更多...
def | SetNewWindowFlag (flag)
| 设置用于决定是否在新窗口中打开目标文档的标志。 更多...
def | SetRootFile (file_specification)
| 设置根文件的文件规范，该根文件是目标的根文件。 更多...
def | SetTarget (target)
| 设置目标。 更多...
Public 成员函数 继承自 FoxitPDFSDKPython3.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 成员函数 继承自 FoxitPDFSDKPython3.Action
def | Create (document, action_type)
| 为指定的动作类型创建新动作。 更多...
静态 Public 属性 继承自 FoxitPDFSDKPython3.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文件中跳转或跳转到该文件。 类FoxitPDFSDKPython3.EmbeddedGotoTarget 派生自Action ， 提供用于获取/设置嵌入转到动作数据的函数。

参见
  Action

## 构造及析构函数说明

## ◆ EmbeddedGotoAction()

def FoxitPDFSDKPython3.EmbeddedGotoAction.EmbeddedGotoAction | ( |  | action | ) |

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

参数

  [in] | action | 父类对象。

## 成员函数说明

## ◆ GetDestination()

def FoxitPDFSDKPython3.EmbeddedGotoAction.GetDestination | ( |  | ) |

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

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

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

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

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

## ◆ GetDestinationName()

def FoxitPDFSDKPython3.EmbeddedGotoAction.GetDestinationName | ( |  | ) |

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

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

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

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

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

## ◆ GetNewWindowFlag()

def FoxitPDFSDKPython3.EmbeddedGotoAction.GetNewWindowFlag | ( |  | ) |

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

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

## ◆ GetRootFile()

def FoxitPDFSDKPython3.EmbeddedGotoAction.GetRootFile | ( |  | ) |

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

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

## ◆ GetTarget()

def FoxitPDFSDKPython3.EmbeddedGotoAction.GetTarget | ( |  | ) |

获取目标。

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

## ◆ SetDestination()

def FoxitPDFSDKPython3.EmbeddedGotoAction.SetDestination | ( |  | destination | ) |

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

参数

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

返回
  无。

## ◆ SetDestinationName()

def FoxitPDFSDKPython3.EmbeddedGotoAction.SetDestinationName | ( |  | dest_name | ) |

设置目标名称。

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

参数

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

返回
  无。

## ◆ SetNewWindowFlag()

def FoxitPDFSDKPython3.EmbeddedGotoAction.SetNewWindowFlag | ( |  | flag | ) |

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

参数

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

返回
  无。

## ◆ SetRootFile()

def FoxitPDFSDKPython3.EmbeddedGotoAction.SetRootFile | ( |  | file_specification | ) |

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

参数

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

返回
  无。

## ◆ SetTarget()

def FoxitPDFSDKPython3.EmbeddedGotoAction.SetTarget | ( |  | target | ) |

设置目标。

参数

  [in] | target | 嵌入转到目标对象。如果这是通过默认构造函数构造的且 没有设置任何值，则表示没有目标。

返回
  无。