类 FSDK::RenditionAction 继承关系图:

Public 成员函数
	constructor (action)
	带有 parent class object. 更多...

	GetJavaScript ()
	获取要执行的JavaScript脚本。更多...

	GetOperationType ()
	获取触发当前呈现操作时的操作类型。更多...

	GetRendition (index)
	按索引获取呈现。更多...

	GetRenditionCount ()
	获取呈现对象的数量。更多...

	GetScreenAnnot ()
	获取相关屏幕注释。更多...

	InsertRendition (rendition, index)
	将呈现插入到当前呈现操作中，位于索引指定的位置。更多...

	RemoveRendition (rendition)
	从当前呈现操作中移除呈现对象。更多...

	SetJavaScript (script)
	设置要执行的JavaScript脚本。更多...

	SetOperationType (op_type)
	设置触发当前呈现操作时的操作类型。更多...

	SetScreenAnnot (screen_annot)
	设置相关屏幕注释。更多...

Public 成员函数继承自 FSDK::Action
	constructor (document, action_dict)
	带参数的构造函数。更多...

	GetDict ()
	获取当前对象的 PDF 字典。更多...

	GetDocument ()
	获取当前操作所属的 PDF 文档。更多...

	GetSubAction (index)
	通过索引获取子操作。更多...

	GetSubActionCount ()
	获取子操作的数量。更多...

	GetType ()
	获取操作类型。更多...

	InsertSubAction (index, sub_action)
	将新子操作插入到索引指定的位置。更多...

	IsEmpty ()
	检查当前对象是否为空。更多...

	RemoveAllSubActions ()
	删除所有子操作。更多...

	RemoveSubAction (index)
	删除由索引指定的子操作。更多...

	SetSubAction (index, sub_action)
	通过索引设置子操作。更多...

静态 Public 属性
static	e_OpTypeAssociate
	将呈现与相关屏幕注释关联。更多...

static	e_OpTypeNone
	Enumeration for operation type to perform when the rendition action is triggered. 更多...

static	e_OpTypePause
	暂停与相关屏幕注释关联的任何正在播放的呈现。如果没有呈现正在播放，则无效果。

static	e_OpTypePlay
	播放呈现（在呈现操作中指定），并将其与相关屏幕注释关联。如果呈现已与注释关联，则在暂停时恢复该呈现；否则，不执行任何操作。

static	e_OpTypeResume
	恢复与相关屏幕注释关联的任何正在播放的呈现。如果没有呈现正在播放或呈现未暂停，则无效果。

static	e_OpTypeStop
	停止与相关屏幕注释关联的任何正在播放的呈现并移除关联。如果没有呈现正在播放，则无效果。

静态 Public 属性继承自 FSDK::Action
static	e_NewWindowFlagFalse
	新窗口标志的枚举。更多...

static	e_NewWindowFlagNone
	无"NewWindow"标志。

static	e_NewWindowFlagTrue
	"NewWindow"标志为 true。

static	e_TypeGoto
	操作类型：跳转操作。

static	e_TypeGoTo3DView
	操作类型：跳转到 3D 视图操作。

static	e_TypeGoToE
	操作类型：嵌入式跳转操作。

static	e_TypeGoToR
	操作类型：远程跳转操作。

static	e_TypeHide
	操作类型：隐藏操作。

static	e_TypeImportData
	操作类型：导入数据操作。

static	e_TypeJavaScript
	操作类型：JavaScript 操作。

static	e_TypeLaunch
	操作类型：启动操作。

static	e_TypeMovie
	操作类型：影片操作。

static	e_TypeNamed
	操作类型：命名操作。

static	e_TypeRendition
	操作类型：演绎操作。

static	e_TypeResetForm
	操作类型：重置表单操作。

static	e_TypeSetOCGState
	操作类型：设置 OCG 状态操作。

static	e_TypeSound
	操作类型：声音操作。

static	e_TypeSubmitForm
	操作类型：提交表单操作。

static	e_TypeThread
	操作类型：线程操作。

static	e_TypeTrans
	操作类型：过渡操作。

static	e_TypeUnknown
	操作类型的枚举。更多...

static	e_TypeURI
	操作类型：统一资源标识符 (URI) 操作。

额外继承的成员函数
静态 Public 成员函数继承自 FSDK::Action
static	Create (document, action_type)
	为指定的操作类型创建新操作。更多...

详细描述

呈现操作用于控制多媒体内容的播放。（有关更多详细信息，请参阅<PDF Reference 1.7> P668 “Rendition Actions”）类 FSDK.RenditionAction 派生自 FSDK.Action，提供获取/设置呈现操作数据的功能。

参见: FSDK.Action

成员函数说明

◆ constructor()

FSDK::RenditionAction::constructor ( action )

带有 parent class object.

参数

[in] action Parent class object.

◆ GetJavaScript()

FSDK::RenditionAction::GetJavaScript ( )

获取要执行的JavaScript脚本。

作为有用的呈现操作，它应包含要执行的JavaScript脚本或在触发时指定要执行的操作类型。如果JavaScript脚本和操作类型都存在，应用程序应执行JavaScript；如果应用程序无法执行JavaScript脚本，则按操作类型定义执行。如果没有JavaScript脚本且操作类型无效，则表示该操作无效。

返回: JavaScript脚本。

◆ GetOperationType()

FSDK::RenditionAction::GetOperationType ( )

获取触发当前呈现操作时的操作类型。

作为有用的呈现操作，它应包含要执行的JavaScript脚本或在触发时指定要执行的操作类型。如果JavaScript脚本和操作类型都存在，应用程序应执行JavaScript；如果应用程序无法执行JavaScript脚本，则按操作类型定义执行。如果没有JavaScript脚本且操作类型无效，则表示该操作无效。

返回: 操作类型。请参考从 FSDK.RenditionAction.e_OpTypeNone 开始的值，这将是这些值之一。

◆ GetRendition()

FSDK::RenditionAction::GetRendition ( index )

按索引获取呈现。

参数

[in] index 要检索的呈现对象的索引。有效范围：从 0 到（count-1）。 count 由函数 FSDK.RenditionAction.GetRenditionCount 返回。

返回: 呈现对象。

◆ GetRenditionCount()

FSDK::RenditionAction::GetRenditionCount ( )

获取呈现对象的数量。

返回: 呈现对象的数量。

◆ GetScreenAnnot()

FSDK::RenditionAction::GetScreenAnnot ( )

获取相关屏幕注释。

返回: 屏幕注释对象。

◆ InsertRendition()

FSDK::RenditionAction::InsertRendition	(	rendition	,
		index
	)

将呈现插入到当前呈现操作中，位于索引指定的位置。

当操作类型为 FSDK.RenditionAction.e_OpTypeAssociate 或 FSDK.RenditionAction.e_OpTypePlay 时，呈现对象对于呈现操作是必需的。

参数

[in]	rendition	要插入的呈现对象。
[in]	index	指定插入呈现对象位置的索引。如果索引低于 0 或大于（count-1），输入的呈现将插入到末尾。count 由函数 FSDK.RenditionAction.GetRenditionCount 返回。

返回: 无。

◆ RemoveRendition()

FSDK::RenditionAction::RemoveRendition ( rendition )

从当前呈现操作中移除呈现对象。

参数

[in] rendition 要从当前呈现操作中移除的呈现对象。

返回: 无。

◆ SetJavaScript()

FSDK::RenditionAction::SetJavaScript ( script )

设置要执行的JavaScript脚本。

作为有用的呈现操作，它应包含要执行的JavaScript脚本或在触发时指定要执行的操作类型。如果JavaScript脚本和操作类型都存在，应用程序应执行JavaScript；如果应用程序无法执行JavaScript脚本，则按操作类型定义执行。如果没有JavaScript脚本且操作类型无效，则表示该操作无效。

参数

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

返回: 无。

◆ SetOperationType()

FSDK::RenditionAction::SetOperationType ( op_type )

设置触发当前呈现操作时的操作类型。

作为有用的呈现操作，它应包含要执行的JavaScript脚本或在触发时指定要执行的操作类型。如果JavaScript脚本和操作类型都存在，应用程序应执行JavaScript；如果应用程序无法执行JavaScript脚本，则按操作类型定义执行。如果没有JavaScript脚本且操作类型无效，则表示该操作无效。

参数

[in] op_type 操作类型。请参考从 FSDK.RenditionAction.e_OpTypeAssociate 开始的值，这应该是这些值之一。如果设置值 FSDK.RenditionAction.e_OpTypeNone，则表示未指定操作类型。

返回: 无。

◆ SetScreenAnnot()

FSDK::RenditionAction::SetScreenAnnot ( screen_annot )

设置相关屏幕注释。

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

参数

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

返回: 无。

类成员变量说明

◆ e_OpTypeAssociate

FSDK::RenditionAction::e_OpTypeAssociate

static

将呈现与相关屏幕注释关联。

如果没有呈现与相关屏幕注释关联，则播放呈现（在呈现操作中指定），并将其与注释关联。如果已有呈现与相关屏幕注释关联，则停止该呈现，并将新呈现（在呈现操作中指定）与注释关联。

◆ e_OpTypeNone

FSDK::RenditionAction::e_OpTypeNone

static

Enumeration for operation type to perform when the rendition action is triggered.

Values of this enumeration should be used alone.

未指定操作。

Public 成员函数

静态 Public 属性

额外继承的成员函数

详细描述

成员函数说明

◆ constructor()

◆ GetJavaScript()

◆ GetOperationType()

◆ GetRendition()

◆ GetRenditionCount()

◆ GetScreenAnnot()

◆ InsertRendition()

◆ RemoveRendition()

◆ SetJavaScript()

◆ SetOperationType()

◆ SetScreenAnnot()

类成员变量说明

◆ e_OpTypeAssociate

◆ e_OpTypeNone