Foxit PDF SDK

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

## Public 成员函数
def | RenditionAction (action)
| 构造函数，使用父类对象。 更多...
def | GetJavaScript ()
| 获取要执行的JavaScript脚本。 更多...
def | GetOperationType ()
| 获取当前再现动作在被触发时的操作类型。 更多...
def | GetRendition (index)
| 通过索引获取再现。 更多...
def | GetRenditionCount ()
| 获取再现对象的数量。 更多...
def | GetScreenAnnot ()
| 获取相关的屏幕注释。 更多...
def | InsertRendition (rendition, index)
| 在索引指定的位置将再现插入到当前再现动作中。 更多...
def | RemoveRendition (rendition)
| 从当前再现动作中移除再现对象。 更多...
def | SetJavaScript (script)
| 设置要执行的JavaScript脚本。 更多...
def | SetOperationType (op_type)
| 设置当前再现动作在被触发时的操作类型。 更多...
def | SetScreenAnnot (screen_annot)
| 设置相关的屏幕注释。 更多...
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 属性
| e_OpTypeAssociate = _fsdk.RenditionAction_e_OpTypeAssociate
| 将再现关联到相关的屏幕注释。 更多...
| e_OpTypeNone = _fsdk.RenditionAction_e_OpTypeNone
| 未指定操作。
| e_OpTypePause = _fsdk.RenditionAction_e_OpTypePause
| 暂停与相关屏幕注释关联播放的任何再现。 如果没有再现正在播放，则没有效果。
| e_OpTypePlay = _fsdk.RenditionAction_e_OpTypePlay
| 播放再现（在再现动作中指定），将其与相关屏幕注释关联。 如果再现已经与注释关联，如果它被暂停则恢复该再现； 否则，什么都不做。
| e_OpTypeResume = _fsdk.RenditionAction_e_OpTypeResume
| 恢复与相关屏幕注释关联播放的任何再现。 如果没有再现正在播放或再现未暂停，则没有效果。
| e_OpTypeStop = _fsdk.RenditionAction_e_OpTypeStop
| 停止与相关屏幕注释关联播放的任何再现并移除关联。 如果没有再现正在播放，则没有效果。
静态 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)动作。

## 额外继承的成员函数
静态 Public 成员函数 继承自 FoxitPDFSDKPython3.Action
def | Create (document, action_type)
| 为指定的动作类型创建新动作。 更多...

## 详细描述

再现动作是控制多媒体内容的播放。(更多详情，请参考 <PDF参考1.7> P668 "再现动作") 类FoxitPDFSDKPython3.RenditionAction 派生自Action ，提供用于 获取/设置再现动作数据的函数。

参见
  Action

## 构造及析构函数说明

## ◆ RenditionAction()

def FoxitPDFSDKPython3.RenditionAction.RenditionAction | ( |  | action | ) |

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

参数

  [in] | action | 父类对象。

## 成员函数说明

## ◆ GetJavaScript()

def FoxitPDFSDKPython3.RenditionAction.GetJavaScript | ( |  | ) |

获取要执行的JavaScript脚本。

作为一个有用的再现动作，它应该包含要执行的JavaScript脚本或 在被触发时指定要执行的操作类型。如果JavaScript脚本和 操作类型都存在，应用程序应该执行JavaScript；如果应用程序无法 执行JavaScript脚本，则按操作类型定义执行。如果没有JavaScript脚本且 操作类型无效，那意味着动作无效。

返回
  JavaScript脚本。

## ◆ GetOperationType()

def FoxitPDFSDKPython3.RenditionAction.GetOperationType | ( |  | ) |

获取当前再现动作在被触发时的操作类型。

作为一个有用的再现动作，它应该包含要执行的JavaScript脚本或 在被触发时指定要执行的操作类型。如果JavaScript脚本和 操作类型都存在，应用程序应该执行JavaScript；如果应用程序无法 执行JavaScript脚本，则按操作类型定义执行。如果没有JavaScript脚本且 操作类型无效，那意味着动作无效。

返回
  操作类型。请参考FoxitPDFSDKPython3.RenditionAction.e_OpTypeNone 开始的值， 这将是这些值中的一个。

## ◆ GetRendition()

def FoxitPDFSDKPython3.RenditionAction.GetRendition | ( |  | index | ) |

通过索引获取再现。

参数

  [in] | index | 要检索的再现对象的索引。有效范围：从0到(count-1)。 count由函数FoxitPDFSDKPython3.RenditionAction.GetRenditionCount 返回。

返回
  再现对象。

## ◆ GetRenditionCount()

def FoxitPDFSDKPython3.RenditionAction.GetRenditionCount | ( |  | ) |

获取再现对象的数量。

返回
  再现对象的数量。

## ◆ GetScreenAnnot()

def FoxitPDFSDKPython3.RenditionAction.GetScreenAnnot | ( |  | ) |

获取相关的屏幕注释。

返回
  屏幕注释对象。

## ◆ InsertRendition()

def FoxitPDFSDKPython3.RenditionAction.InsertRendition | ( |  | rendition,
|  |  | index
| ) |  |

在索引指定的位置将再现插入到当前再现动作中。

当操作类型为FoxitPDFSDKPython3.RenditionAction.e_OpTypeAssociate 或 FoxitPDFSDKPython3.RenditionAction.e_OpTypeAssociate 时，再现对象对于再现动作是必需的。

参数

  [in] | rendition | 要插入的再现对象。
  [in] | index | 指定插入再现对象位置的索引。 如果索引小于0或大于(count-1)，输入的再现将被 插入到末尾。count由函数 FoxitPDFSDKPython3.RenditionAction.GetRenditionCount 返回。

返回
  无。

## ◆ RemoveRendition()

def FoxitPDFSDKPython3.RenditionAction.RemoveRendition | ( |  | rendition | ) |

从当前再现动作中移除再现对象。

参数

  [in] | rendition | 要从当前再现动作中移除的再现对象。

返回
  无。

## ◆ SetJavaScript()

def FoxitPDFSDKPython3.RenditionAction.SetJavaScript | ( |  | script | ) |

设置要执行的JavaScript脚本。

作为一个有用的再现动作，它应该包含要执行的JavaScript脚本或 在被触发时指定要执行的操作类型。如果JavaScript脚本和 操作类型都存在，应用程序应该执行JavaScript；如果应用程序无法 执行JavaScript脚本，则按操作类型定义执行。如果没有JavaScript脚本且 操作类型无效，那意味着动作无效。

参数

  [in] | script | 要设置的JavaScript脚本。

返回
  无。

## ◆ SetOperationType()

def FoxitPDFSDKPython3.RenditionAction.SetOperationType | ( |  | op_type | ) |

设置当前再现动作在被触发时的操作类型。

作为一个有用的再现动作，它应该包含要执行的JavaScript脚本或 在被触发时指定要执行的操作类型。如果JavaScript脚本和 操作类型都存在，应用程序应该执行JavaScript；如果应用程序无法 执行JavaScript脚本，则按操作类型定义执行。如果没有JavaScript脚本且 操作类型无效，那意味着动作无效。

参数

  [in] | op_type | 操作类型。请参考FoxitPDFSDKPython3.RenditionAction.e_OpTypeAssociate 开始的值， 这应该是这些值中的一个。如果设置值FoxitPDFSDKPython3.RenditionAction.e_OpTypeNone ， 那意味着没有指定操作类型。

返回
  无。

## ◆ SetScreenAnnot()

def FoxitPDFSDKPython3.RenditionAction.SetScreenAnnot | ( |  | screen_annot | ) |

设置相关的屏幕注释。

当操作类型设置为有效值时，此属性是必需的。

参数

  [in] | screen_annot | 要设置为相关屏幕注释的屏幕注释对象。

返回
  无。

## 类成员变量说明

## ◆ e_OpTypeAssociate

FoxitPDFSDKPython3.RenditionAction.e_OpTypeAssociate = _fsdk.RenditionAction_e_OpTypeAssociate
| static

将再现关联到相关的屏幕注释。

如果没有再现与相关屏幕注释关联， 播放再现（在再现动作中指定），将其与注释关联。 如果再现已经与相关屏幕注释关联，停止它，并且 新的再现（在再现动作中指定）与注释关联。