Foxit PDF SDK

Public 成员函数 | 静态 Public 成员函数 | 静态 Public 属性 | 所有成员列表
FoxitPDFSDKPython3.Action类 参考
类 FoxitPDFSDKPython3.Action 继承关系图:

## Public 成员函数
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 成员函数
def | Create (document, action_type)
| 为指定的动作类型创建新动作。 更多...

## 静态 Public 属性
| 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支持以下标准动作类型：
"转到动作"、"远程转到动作"、"嵌入转到动作"、"启动动作"、"线程动作"、 "URI动作"、"声音动作"、"电影动作"、"隐藏动作"、"命名动作"、"提交表单动作"、 "重置表单动作"、"导入数据动作"、"JavaScript动作"、"设置OCG状态动作"、 "演示动作"、"过渡动作"、"转到3D视图动作"。
PDF动作可能有子动作。当此动作被触发时，其子动作也应依次被触发。
类Action 是所有类型PDF动作的基类。对于具体的动作类型，请参考 派生类。函数FoxitPDFSDKPython3.Action.Create 可用于创建新动作 – 目前仅支持 某些动作类型。请参考此函数的注释以获取更多详细信息。此类还提供了修改子动作的函数。

## 构造及析构函数说明

## ◆ Action()

def FoxitPDFSDKPython3.Action.Action | ( |  | action | ) |

构造函数，使用另一个动作对象。

参数

  [in] | action | 另一个动作对象。

## 成员函数说明

## ◆ Create()

FoxitPDFSDKPython3.Action.Create | ( |  | document,
|  |  | action_type
| ) |  |
| static

为指定的动作类型创建新动作。

新创建的动作尚未有动作数据（除了动作类型）。 用户需要调用具体动作类中的函数来设置动作数据。

参数

  [in] | document | 新动作所属的有效PDF文档。
  [in] | action_type | 动作类型，用于指定要创建的动作类型。 目前仅支持： FoxitPDFSDKPython3.Action.e_TypeGoto 、FoxitPDFSDKPython3.Action.e_TypeURI 、 FoxitPDFSDKPython3.Action.e_TypeJavaScript 、FoxitPDFSDKPython3.Action.e_TypeNamed 、 FoxitPDFSDKPython3.Action.e_TypeGoToR 、FoxitPDFSDKPython3.Action.e_TypeGoToE 、 FoxitPDFSDKPython3.Action.e_TypeSubmitForm 、FoxitPDFSDKPython3.Action.e_TypeResetForm 、 FoxitPDFSDKPython3.Action.e_TypeHide 、FoxitPDFSDKPython3.Action.e_TypeLaunch 、 FoxitPDFSDKPython3.Action.e_TypeImportData 、FoxitPDFSDKPython3.Action.e_TypeRendition 、 FoxitPDFSDKPython3.Action.e_TypeSetOCGState 、FoxitPDFSDKPython3.Action.e_TypeThread ，

返回
  没有动作数据的新动作对象。

## ◆ GetDict()

def FoxitPDFSDKPython3.Action.GetDict | ( |  | ) |

获取当前对象的PDF字典。

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

## ◆ GetDocument()

def FoxitPDFSDKPython3.Action.GetDocument | ( |  | ) |

获取当前动作所属的PDF文档。

返回
  PDF文档对象。

## ◆ GetSubAction()

def FoxitPDFSDKPython3.Action.GetSubAction | ( |  | index | ) |

按索引获取子动作。

参数

  [in] | index | 要检索的子动作的索引。有效范围：从0到(count-1)。 count由函数FoxitPDFSDKPython3.Action.GetSubActionCount 返回。

返回
  表示指定子动作的动作对象。

## ◆ GetSubActionCount()

def FoxitPDFSDKPython3.Action.GetSubActionCount | ( |  | ) |

获取子动作的数量。

返回
  子动作的数量。

## ◆ GetType()

def FoxitPDFSDKPython3.Action.GetType | ( |  | ) |

获取动作类型。

返回
  动作类型。请参考从FoxitPDFSDKPython3.Action.e_TypeGoto 开始的值， 这将是这些值中的一个。

## ◆ InsertSubAction()

def FoxitPDFSDKPython3.Action.InsertSubAction | ( |  | index,
|  |  | sub_action
| ) |  |

在指定索引位置插入新的子动作。

参数

  [in] | index | 要插入新子动作的位置索引。 如果此索引值小于零，新子动作将被插入为第一个。 如果此索引值等于或大于当前子动作数量，新子动作将 被插入为最后一个。
  [in] | sub_action | 要插入的新子动作。当前仅支持以下类型 作为新子动作： FoxitPDFSDKPython3.Action.e_TypeGoto ，FoxitPDFSDKPython3.Action.e_TypeURI ， FoxitPDFSDKPython3.Action.e_TypeJavaScript ，FoxitPDFSDKPython3.Action.e_TypeNamed ， FoxitPDFSDKPython3.Action.e_TypeGoToR ，FoxitPDFSDKPython3.Action.e_TypeGoToE ， FoxitPDFSDKPython3.Action.e_TypeSubmitForm ，FoxitPDFSDKPython3.Action.e_TypeResetForm ， FoxitPDFSDKPython3.Action.e_TypeHide ，FoxitPDFSDKPython3.Action.e_TypeLaunch ， FoxitPDFSDKPython3.Action.e_TypeImportData ，FoxitPDFSDKPython3.Action.e_TypeRendition 。

返回
  无。

## ◆ IsEmpty()

def FoxitPDFSDKPython3.Action.IsEmpty | ( |  | ) |

检查当前对象是否为空。

当当前对象为空时，意味着当前对象无用。

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

## ◆ RemoveAllSubActions()

def FoxitPDFSDKPython3.Action.RemoveAllSubActions | ( |  | ) |

移除所有子动作。

返回
  无。

## ◆ RemoveSubAction()

def FoxitPDFSDKPython3.Action.RemoveSubAction | ( |  | index | ) |

移除指定索引的子动作。

参数

  [in] | index | 要移除的子动作的索引。有效范围：从0到（count-1）。 count由函数FoxitPDFSDKPython3.Action.GetSubActionCount 返回。

返回
  无。

## ◆ SetSubAction()

def FoxitPDFSDKPython3.Action.SetSubAction | ( |  | index,
|  |  | sub_action
| ) |  |

按索引设置子动作。

参数

  [in] | index | 要检索的子动作的索引。有效范围：从0到(count-1)。 count由函数FoxitPDFSDKPython3.Action.GetSubActionCount 返回。
  [in] | sub_action | 要设置为子动作的动作对象。目前仅支持以下类型 作为子动作： FoxitPDFSDKPython3.Action.e_TypeGoto 、FoxitPDFSDKPython3.Action.e_TypeURI 、 FoxitPDFSDKPython3.Action.e_TypeJavaScript 、FoxitPDFSDKPython3.Action.e_TypeNamed 、 FoxitPDFSDKPython3.Action.e_TypeGoToR 、FoxitPDFSDKPython3.Action.e_TypeGoToE 、 FoxitPDFSDKPython3.Action.e_TypeSubmitForm 、FoxitPDFSDKPython3.Action.e_TypeResetForm 、 FoxitPDFSDKPython3.Action.e_TypeHide 、FoxitPDFSDKPython3.Action.e_TypeLaunch 、 FoxitPDFSDKPython3.Action.e_TypeImportData 、FoxitPDFSDKPython3.Action.e_TypeRendition 、 FoxitPDFSDKPython3.Action.e_TypeSetOCGState 。

返回
  无。