Foxit PDF SDK
FSRenditionAction类 参考
类 FSRenditionAction 继承关系图:
FSAction FSBase

构造函数

(FSRendition *) - getRendition:
 通过索引获取再现。
更多...
 
(int) - getRenditionCount
 获取再现对象的数量。
更多...
 
(id) - initWithAction:
 构造函数,使用父类对象。
更多...
 
(void) - insertRendition:index:
 在索引指定的位置将再现插入到当前再现动作中。
更多...
 
(void) - removeRendition:
 从当前再现动作中移除再现对象。
更多...
 
- 构造函数 继承自 FSAction
(FSPDFDictionary *) - getDict
 获取当前对象的PDF字典。
更多...
 
(FSPDFDoc *) - getDocument
 获取当前动作所属的PDF文档。
更多...
 
(FSAction *) - getSubAction:
 按索引获取子动作。
更多...
 
(int) - getSubActionCount
 获取子动作的数量。
更多...
 
(FSActionType- getType
 获取动作类型。
更多...
 
(id) - initWithDocument:action_dict:
 构造函数,带参数。
更多...
 
(void) - insertSubAction:sub_action:
 在指定索引位置插入新的子动作。
更多...
 
(BOOL) - isEmpty
 检查当前对象是否为空。
更多...
 
(void) - removeAllSubActions
 移除所有子动作。
更多...
 
(void) - removeSubAction:
 移除指定索引的子动作。
更多...
 
(void) - setSubAction:sub_action:
 按索引设置子动作。
更多...
 

属性

NSString * javaScript
 获取要执行的JavaScript脚本。
更多...
 
FSRenditionActionOperationType operationType
 获取当前再现动作在被触发时的操作类型。
更多...
 
FSScreenscreenAnnot
 获取相关的屏幕注释。

 

额外继承的成员函数

- 类方法 继承自 FSAction
(FSAction *) + create:action_type:
 为指定的动作类型创建新动作。
更多...
 

详细描述

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

参见
FSAction

函数文档

◆ getRendition:()

- (FSRendition *) getRendition: (int)  index

通过索引获取再现。

参数
[in]index要检索的再现对象的索引。有效范围:从0到(count-1)。 count由函数FSRenditionAction::getRenditionCount返回。
返回
再现对象。

◆ getRenditionCount()

- (int) getRenditionCount

获取再现对象的数量。

返回
再现对象的数量。

◆ initWithAction:()

- (id) initWithAction: (FSAction*)  action

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

参数
[in]action父类对象。

重载 FSAction .

◆ insertRendition:index:()

- (void) insertRendition: (FSRendition*)  rendition
index: (int)  index 

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

当操作类型为FSRenditionActionOpTypeAssociateFSRenditionActionOpTypeAssociate时,再现对象对于再现动作是必需的。

参数
[in]rendition要插入的再现对象。
[in]index指定插入再现对象位置的索引。 如果索引小于0或大于(count-1),输入的再现将被 插入到末尾。count由函数 FSRenditionAction::getRenditionCount返回。
返回
无。

◆ removeRendition:()

- (void) removeRendition: (FSRendition*)  rendition

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

参数
[in]rendition要从当前再现动作中移除的再现对象。
返回
无。

属性说明

◆ javaScript

- (NSString *) javaScript
readwritenonatomicweak

获取要执行的JavaScript脚本。

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

◆ operationType

- (FSRenditionActionOperationType) operationType
readwritenonatomicassign

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

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