fsdk.AdditionalAction类 参考

Public 成员函数
def	DoJSAction (trigger)
	执行由触发器事件类型指定的JavaScript动作。 更多...
def	GetAction (trigger)
	获取具有指定触发器事件类型的动作。 更多...
def	GetDict ()
	获取当前对象的PDF字典。 更多...
def	IsEmpty ()
	检查当前对象是否为空。 更多...
def	RemoveAction (trigger)
	移除具有指定触发器事件类型的动作。 更多...
def	RemoveAllActions ()
	移除所有动作。 更多...
def	SetAction (trigger, action)
	为指定的触发器事件类型设置附加动作。 更多...

详细描述

注释、页面对象或（从PDF 1.3开始）交互式表单字段可能包含名为"AA"的条目， 该条目指定附加动作字典（PDF 1.2），扩展了可以触发动作执行的事件集。 在PDF 1.4中，文档目录字典也可能包含影响整个文档的触发事件的"AA"条目。
此类可以从PDF文档、PDF页面、PDF表单字段、PDF注释（仅某些类型）或 现有的附加动作字典构造，可用于从PDF文档、PDF页面、PDF表单字段或PDF注释的 附加动作字典获取/设置数据。

成员函数说明

DoJSAction()

def fsdk.AdditionalAction.DoJSAction

(

trigger

)

执行由触发器事件类型指定的JavaScript动作。

如果当前对象是用有效的PDF字典构造的，此函数将直接返回false 因为福昕PDF SDK无法知道附加动作字典与哪种对象关联。

参数

[in]

trigger

输入的触发器事件类型。它应该是： 如果当前附加动作是从PDF页面构造的，触发器值必须是 从fsdk.AdditionalActionE_TriggerPageOpened 开始的值之一 （具有相同的前缀名称）。 如果当前附加动作是从PDF文档构造的，触发器值必须是 从fsdk.AdditionalActionE_TriggerDocWillClose 开始的值之一 （具有相同的前缀名称）。 如果当前附加动作是从PDF表单字段构造的，触发器值必须是 从fsdk.AdditionalActionE_TriggerFieldKeyStroke 开始的值之一 （具有相同的前缀名称）。 如果当前附加动作是从PDF注释构造的，触发器值必须是 从fsdk.AdditionalActionE_TriggerAnnotCursorEnter 开始的值之一 （具有相同的前缀名称）。

返回

true表示成功，而false表示失败或当前对象是从PDF字典构造的。

GetAction()

def fsdk.AdditionalAction.GetAction

(

trigger

)

获取具有指定触发器事件类型的动作。

参数

[in]

trigger

输入的触发器事件类型。它应该是： 如果当前附加动作是从PDF字典构造的，触发器值可以是 枚举类TriggerEvent中定义的值之一。 如果当前附加动作是从PDF页面构造的，触发器值必须是 从fsdk.AdditionalActionE_TriggerPageOpened 开始的值之一 （具有相同的前缀名称）。 如果当前附加动作是从PDF文档构造的，触发器值必须是 从fsdk.AdditionalActionE_TriggerDocWillClose 开始的值之一 （具有相同的前缀名称）。 如果当前附加动作是从PDF表单字段构造的，触发器值必须是 从fsdk.AdditionalActionE_TriggerFieldKeyStroke 开始的值之一 （具有相同的前缀名称）。 如果当前附加动作是从PDF注释构造的，触发器值必须是 从fsdk.AdditionalActionE_TriggerAnnotCursorEnter 开始的值之一 （具有相同的前缀名称）。

返回

动作对象。

GetDict()

def fsdk.AdditionalAction.GetDict

(

)

获取当前对象的PDF字典。

返回

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

IsEmpty()

def fsdk.AdditionalAction.IsEmpty

(

)

检查当前对象是否为空。

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

返回

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

RemoveAction()

def fsdk.AdditionalAction.RemoveAction

(

trigger

)

移除具有指定触发器事件类型的动作。

如果输入的触发器事件类型有效但没有动作时，此函数将直接返回true。

参数

[in]

trigger

输入的触发器事件类型。它应该是： 如果当前附加动作是从PDF字典构造的，触发器值可以是 枚举类TriggerEvent中定义的值之一。 如果当前附加动作是从PDF页面构造的，触发器值必须是 从fsdk.AdditionalActionE_TriggerPageOpened 开始的值之一 （具有相同的前缀名称）。 如果当前附加动作是从PDF文档构造的，触发器值必须是 从fsdk.AdditionalActionE_TriggerDocWillClose 开始的值之一 （具有相同的前缀名称）。 如果当前附加动作是从PDF表单字段构造的，触发器值必须是 从fsdk.AdditionalActionE_TriggerFieldKeyStroke 开始的值之一 （具有相同的前缀名称）。 如果当前附加动作是从PDF注释构造的，触发器值必须是 从fsdk.AdditionalActionE_TriggerAnnotCursorEnter 开始的值之一 （具有相同的前缀名称）。

返回

true表示成功，而false表示失败。

RemoveAllActions()

def fsdk.AdditionalAction.RemoveAllActions

(

)

移除所有动作。

返回

true表示成功，而false表示失败。

SetAction()

def fsdk.AdditionalAction.SetAction	(		trigger,
			action
	)

为指定的触发器事件类型设置附加动作。

参数

[in]	trigger	输入的触发器事件类型。它应该是： 如果当前附加动作是从PDF字典构造的，触发器值可以是 枚举类TriggerEvent中定义的值之一。 如果当前附加动作是从PDF页面构造的，触发器值必须是 从fsdk.AdditionalActionE_TriggerPageOpened 开始的值之一 （具有相同的前缀名称）。 如果当前附加动作是从PDF文档构造的，触发器值必须是 从fsdk.AdditionalActionE_TriggerDocWillClose 开始的值之一 （具有相同的前缀名称）。 如果当前附加动作是从PDF表单字段构造的，触发器值必须是 从fsdk.AdditionalActionE_TriggerFieldKeyStroke 开始的值之一 （具有相同的前缀名称）。 如果当前附加动作是从PDF注释构造的，触发器值必须是 从fsdk.AdditionalActionE_TriggerAnnotCursorEnter 开始的值之一 （具有相同的前缀名称）。
[in]	action	要设置的动作对象。 如果当前附加动作是从PDF文档或PDF表单字段构造的，此动作的类型应该 是fsdk.ActionE_TypeJavaScript 。 如果当前附加动作是从PDF页面、PDF注释或PDF字典构造的， 请参考触发器事件的注释来检查是否只能使用指定类型的动作。 通常，支持以下类型作为新动作： 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 。

返回

无。