fsdk.Action类 参考

Public 成员函数
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)
	按索引设置子动作。 更多...

详细描述

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

成员函数说明

GetDict()

def fsdk.Action.GetDict

(

)

获取当前对象的PDF字典。

返回

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

GetDocument()

def fsdk.Action.GetDocument

(

)

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

返回

PDF文档对象。

GetSubAction()

def fsdk.Action.GetSubAction

(

index

)

按索引获取子动作。

参数

[in]

index

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

返回

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

GetSubActionCount()

def fsdk.Action.GetSubActionCount

(

)

获取子动作的数量。

返回

子动作的数量。

GetType()

def fsdk.Action.GetType

(

)

获取动作类型。

返回

动作类型。请参考从fsdk.ActionE_TypeGoto 开始的值， 这将是这些值中的一个。

InsertSubAction()

def fsdk.Action.InsertSubAction	(		index,
			sub_action
	)

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

参数

[in]	index	要插入新子动作的位置索引。 如果此索引值小于零，新子动作将被插入为第一个。 如果此索引值等于或大于当前子动作数量，新子动作将 被插入为最后一个。
[in]	sub_action	要插入的新子动作。当前仅支持以下类型 作为新子动作： fsdk.ActionE_TypeGoto ，fsdk.ActionE_TypeURI ， fsdk.ActionE_TypeJavaScript ，fsdk.ActionE_TypeNamed ， fsdk.ActionE_TypeGoToR ，fsdk.ActionE_TypeGoToE ， fsdk.ActionE_TypeSubmitForm ，fsdk.ActionE_TypeResetForm ， fsdk.ActionE_TypeHide ，fsdk.ActionE_TypeLaunch ， fsdk.ActionE_TypeImportData ，fsdk.ActionE_TypeRendition 。

返回

无。

IsEmpty()

def fsdk.Action.IsEmpty

(

)

检查当前对象是否为空。

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

返回

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

RemoveAllSubActions()

def fsdk.Action.RemoveAllSubActions

(

)

移除所有子动作。

返回

无。

RemoveSubAction()

def fsdk.Action.RemoveSubAction

(

index

)

移除指定索引的子动作。

参数

[in]

index

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

返回

无。

SetSubAction()

def fsdk.Action.SetSubAction	(		index,
			sub_action
	)

按索引设置子动作。

参数

[in]	index	要检索的子动作的索引。有效范围：从0到(count-1)。 count由函数fsdk.Action.GetSubActionCount 返回。
[in]	sub_action	要设置为子动作的动作对象。目前仅支持以下类型 作为子动作： fsdk.ActionE_TypeGoto 、fsdk.ActionE_TypeURI 、 fsdk.ActionE_TypeJavaScript 、fsdk.ActionE_TypeNamed 、 fsdk.ActionE_TypeGoToR 、fsdk.ActionE_TypeGoToE 、 fsdk.ActionE_TypeSubmitForm 、fsdk.ActionE_TypeResetForm 、 fsdk.ActionE_TypeHide 、fsdk.ActionE_TypeLaunch 、 fsdk.ActionE_TypeImportData 、fsdk.ActionE_TypeRendition 、 fsdk.ActionE_TypeSetOCGState 。

返回

无。