Foxit PDF SDK
FSAdditionalAction类 参考

未知语言。
更多...

类 FSAdditionalAction 继承关系图:
FSBase

构造函数

(BOOL) - doJSAction:
 执行由触发器事件类型指定的JavaScript动作。
更多...
 
(FSAction *) - getAction:
 获取具有指定触发器事件类型的动作。
更多...
 
(FSPDFDictionary *) - getDict
 获取当前对象的PDF字典。
更多...
 
(id) - initWithAnnot:
 构造函数,从PDF注释。
更多...
 
(id) - initWithDoc:pdf_dict:
 构造函数,从PDF文档或PDF字典(如果有)。
更多...
 
(id) - initWithField:
 构造函数,从PDF表单字段。
更多...
 
(id) - initWithOther:
 构造函数,使用另一个附加动作对象。
更多...
 
(id) - initWithPage:
 构造函数,从PDF页面。
更多...
 
(BOOL) - isEmpty
 检查当前对象是否为空。
更多...
 
(BOOL) - removeAction:
 移除具有指定触发器事件类型的动作。
更多...
 
(BOOL) - removeAllActions
 移除所有动作。
更多...
 
(void) - setAction:action:
 为指定的触发器事件类型设置附加动作。
更多...
 

详细描述

未知语言。

简体中文。

繁体中文。

丹麦语。

德语。

英语。

西班牙语。

法语。

意大利语。

韩语。

日语。

荷兰语。

挪威语。

巴西葡萄牙语。

芬兰语。

瑞典语。

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

函数文档

◆ doJSAction:()

- (BOOL) doJSAction: (FSAdditionalActionTriggerEvent trigger

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

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

参数
[in]trigger输入的触发器事件类型。它应该是:
返回
YES表示成功,而NO表示失败或当前对象是从PDF字典构造的。

◆ getAction:()

- (FSAction *) getAction: (FSAdditionalActionTriggerEvent trigger

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

参数
[in]trigger输入的触发器事件类型。它应该是:
  • 如果当前附加动作是从PDF字典构造的,触发器值可以是 枚举类TriggerEvent中定义的值之一。
  • 如果当前附加动作是从PDF页面构造的,触发器值必须是 从FSAdditionalActionTriggerPageOpened开始的值之一 (具有相同的前缀名称)。
  • 如果当前附加动作是从PDF文档构造的,触发器值必须是 从FSAdditionalActionTriggerDocWillClose开始的值之一 (具有相同的前缀名称)。
  • 如果当前附加动作是从PDF表单字段构造的,触发器值必须是 从FSAdditionalActionTriggerFieldKeyStroke开始的值之一 (具有相同的前缀名称)。
  • 如果当前附加动作是从PDF注释构造的,触发器值必须是 从FSAdditionalActionTriggerAnnotCursorEnter开始的值之一 (具有相同的前缀名称)。

返回
动作对象。

◆ getDict()

- (FSPDFDictionary *) getDict

获取当前对象的PDF字典。

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

◆ initWithAnnot:()

- (id) initWithAnnot: (FSAnnot*)  annot

构造函数,从PDF注释。

参数
[in]annot有效的PDF注释。目前,仅支持小部件和屏幕注释。 对于其他类型的注释,此函数将抛出异常 FSErrUnsupported

◆ initWithDoc:pdf_dict:()

- (id) initWithDoc: (FSPDFDoc*)  doc
pdf_dict: (FSPDFDictionary*)  pdf_dict 

构造函数,从PDF文档或PDF字典(如果有)。

参数
[in]doc有效的PDF文档对象。
[in]pdf_dict表示附加动作字典的PDF字典。 如果此参数为nil,那意味着仅使用PDF文档构造附加动作对象。 如果此参数不为nil,那意味着从此PDF字典构造附加动作对象, 该字典应已存在于指定的PDF文档中并表示附加动作字典。 默认值:nil

◆ initWithField:()

- (id) initWithField: (FSField*)  field

构造函数,从PDF表单字段。

参数
[in]field有效的PDF表单字段。

◆ initWithOther:()

- (id) initWithOther: (FSAdditionalAction*)  other

构造函数,使用另一个附加动作对象。

参数
[in]other另一个附加动作对象。

◆ initWithPage:()

- (id) initWithPage: (FSPDFPage*)  page

构造函数,从PDF页面。

参数
[in]page有效的PDF页面对象。

◆ isEmpty()

- (BOOL) isEmpty

检查当前对象是否为空。

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

返回
YES表示当前对象为空,而NO表示不为空。

◆ removeAction:()

- (BOOL) removeAction: (FSAdditionalActionTriggerEvent trigger

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

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

参数
[in]trigger输入的触发器事件类型。它应该是:
  • 如果当前附加动作是从PDF字典构造的,触发器值可以是 枚举类TriggerEvent中定义的值之一。
  • 如果当前附加动作是从PDF页面构造的,触发器值必须是 从FSAdditionalActionTriggerPageOpened开始的值之一 (具有相同的前缀名称)。
  • 如果当前附加动作是从PDF文档构造的,触发器值必须是 从FSAdditionalActionTriggerDocWillClose开始的值之一 (具有相同的前缀名称)。
  • 如果当前附加动作是从PDF表单字段构造的,触发器值必须是 从FSAdditionalActionTriggerFieldKeyStroke开始的值之一 (具有相同的前缀名称)。
  • 如果当前附加动作是从PDF注释构造的,触发器值必须是 从FSAdditionalActionTriggerAnnotCursorEnter开始的值之一 (具有相同的前缀名称)。

返回
YES表示成功,而NO表示失败。

◆ removeAllActions()

- (BOOL) removeAllActions

移除所有动作。

返回
YES表示成功,而NO表示失败。

◆ setAction:action:()

- (void) setAction: (FSAdditionalActionTriggerEvent trigger
action: (FSAction*)  action 

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

参数
[in]trigger输入的触发器事件类型。它应该是:
  • 如果当前附加动作是从PDF字典构造的,触发器值可以是 枚举类TriggerEvent中定义的值之一。
  • 如果当前附加动作是从PDF页面构造的,触发器值必须是 从FSAdditionalActionTriggerPageOpened开始的值之一 (具有相同的前缀名称)。
  • 如果当前附加动作是从PDF文档构造的,触发器值必须是 从FSAdditionalActionTriggerDocWillClose开始的值之一 (具有相同的前缀名称)。
  • 如果当前附加动作是从PDF表单字段构造的,触发器值必须是 从FSAdditionalActionTriggerFieldKeyStroke开始的值之一 (具有相同的前缀名称)。
  • 如果当前附加动作是从PDF注释构造的,触发器值必须是 从FSAdditionalActionTriggerAnnotCursorEnter开始的值之一 (具有相同的前缀名称)。

[in]action要设置的动作对象。
如果当前附加动作是从PDF文档或PDF表单字段构造的,此动作的类型应该 是FSActionTypeJavaScript
如果当前附加动作是从PDF页面、PDF注释或PDF字典构造的, 请参考触发器事件的注释来检查是否只能使用指定类型的动作。 通常,支持以下类型作为新动作:
FSActionTypeGoto, FSActionTypeURI, FSActionTypeJavaScript, FSActionTypeNamed, FSActionTypeGoToR, FSActionTypeGoToE, FSActionTypeSubmitForm, FSActionTypeResetForm, FSActionTypeHide, FSActionTypeLaunch, FSActionTypeImportData, FSActionTypeRendition
返回
无。