Foxit PDF SDK

Public 成员函数 | 静态 Public 属性 | 所有成员列表
FSDK::AdditionalAction类 参考

## Public 成员函数
| constructor (annot)
| 从PDF注释构造的构造函数。 更多...
| constructor (doc, pdf_dict)
| 从PDF文档或PDF字典（如果有）构造的构造函数。 更多...
| constructor (field)
| 从PDF表单域构造的构造函数。 更多...
| constructor (page)
| 从PDF页面构造的构造函数。 更多...
| DoJSAction (trigger)
| 执行由触发事件类型指定的JavaScript操作。 更多...
| GetAction (trigger)
| 获取具有指定触发事件类型的操作。 更多...
| GetDict ()
| 获取当前对象的PDF字典。 更多...
| IsEmpty ()
| 检查当前对象是否为空。 更多...
| RemoveAction (trigger)
| 移除具有指定触发事件类型的操作。 更多...
| RemoveAllActions ()
| 移除所有操作。 更多...
| SetAction (trigger, action)
| 为指定的触发事件类型设置附加操作。 更多...

## 静态 Public 属性
static | e_TriggerAnnotCursorEnter
| 当光标进入注释的活动区域时触发要执行的操作。 更多...
static | e_TriggerAnnotCursorExit
| 当光标离开注释的活动区域时触发要执行的操作。 更多...
static | e_TriggerAnnotLoseInputFocus
| (仅适用于小部件注释)当注释失去输入焦点时触发要执行的操作。 更多...
static | e_TriggerAnnotMouseButtonPressed
| 当在注释的活动区域内按下鼠标按钮时触发要执行的操作。 更多...
static | e_TriggerAnnotMouseButtonReleased
| 当在注释的活动区域内释放鼠标按钮时触发要执行的操作。 更多...
static | e_TriggerAnnotPageClosed
| 当包含注释的页面被关闭时触发要执行的操作。 更多...
static | e_TriggerAnnotPageInvisible
| 当包含注释的页面在查看器应用程序的用户界面中不再可见时触发要执行的操作。 更多...
static | e_TriggerAnnotPageOpened
| 当包含注释的页面被打开时触发要执行的操作。 更多...
static | e_TriggerAnnotPageVisible
| 当包含注释的页面在查看器应用程序的用户界面中变得可见时触发要执行的操作。 更多...
static | e_TriggerAnnotReceiveInputFocus
| (仅适用于小部件注释)当注释接收到输入焦点时触发要执行的操作。 更多...
static | e_TriggerDocPrinted
| 在打印文档之后触发要执行的JavaScript操作。 更多...
static | e_TriggerDocSaved
| 在保存文档之后触发要执行的JavaScript操作。 更多...
static | e_TriggerDocWillClose
| 在关闭文档之前触发要执行的JavaScript操作。 更多...
static | e_TriggerDocWillPrint
| 在打印文档之前触发要执行的JavaScript操作。 更多...
static | e_TriggerDocWillSave
| 在保存文档之前触发要执行的JavaScript操作。 更多...
static | e_TriggerFieldKeyStroke
| 当用户在文本域或组合框中键入键盘按键或修改可滚动列表框中的选择时触发要执行的JavaScript操作。 更多...
static | e_TriggerFieldRecalculateValue
| 当另一个字段的值发生更改时，触发要执行的JavaScript操作以重新计算此字段的值。 更多...
static | e_TriggerFieldValueChanged
| 当字段的值被更改时触发要执行的JavaScript操作。 更多...
static | e_TriggerFieldWillFormat
| 在格式化字段以显示其当前值之前触发要执行的JavaScript操作。 更多...
static | e_TriggerPageClosed
| 当页面关闭时触发要执行的操作。 更多...
static | e_TriggerPageOpened
| Enumeration for trigger event. 更多...

## 详细描述

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

## 成员函数说明

## ◆ constructor() [1/4]

FSDK::AdditionalAction::constructor | ( | annot |  | ) |

从PDF注释构造的构造函数。

参数

  [in] | annot | 一个有效的PDF注释。当前仅支持小部件和屏幕注释。 对于其他类型的注释，此函数将抛出异常 FSDK.e_ErrUnsupported。

## ◆ constructor() [2/4]

FSDK::AdditionalAction::constructor | ( | doc | ,
|  | pdf_dict |
| ) |  |

从PDF文档或PDF字典（如果有）构造的构造函数。

参数

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

## ◆ constructor() [3/4]

FSDK::AdditionalAction::constructor | ( | field |  | ) |

从PDF表单域构造的构造函数。

参数

  [in] | field | 一个有效的PDF表单域。

## ◆ constructor() [4/4]

FSDK::AdditionalAction::constructor | ( | page |  | ) |

从PDF页面构造的构造函数。

参数

  [in] | page | 一个有效的PDF页面对象。

## ◆ DoJSAction()

FSDK::AdditionalAction::DoJSAction | ( | trigger |  | ) |

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

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

参数

  [in] | trigger | 输入的触发事件类型。它应该是: 如果当前附加操作是从PDF页面构造的，触发器值必须是 从 FSDK.AdditionalAction.e_TriggerPageOpened 开始的值之一 （具有相同的前缀名称）。 如果当前附加操作是从PDF文档构造的，触发器值必须是 从 FSDK.AdditionalAction.e_TriggerDocWillClose 开始的值之一 （具有相同的前缀名称）。 如果当前附加操作是从PDF表单域构造的，触发器值必须是 从 FSDK.AdditionalAction.e_TriggerFieldKeyStroke 开始的值之一 （具有相同的前缀名称）。 如果当前附加操作是从PDF注释构造的，触发器值必须是 从 FSDK.AdditionalAction.e_TriggerAnnotCursorEnter 开始的值之一 （具有相同的前缀名称）。

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

## ◆ GetAction()

FSDK::AdditionalAction::GetAction | ( | trigger |  | ) |

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

参数

  [in] | trigger | 输入的触发事件类型。它应该是: 如果当前附加操作是从PDF字典构造的，触发器值可以是 枚举类TriggerEvent中定义的值之一。 如果当前附加操作是从PDF页面构造的，触发器值必须是 从 FSDK.AdditionalAction.e_TriggerPageOpened 开始的值之一 （具有相同的前缀名称）。 如果当前附加操作是从PDF文档构造的，触发器值必须是 从 FSDK.AdditionalAction.e_TriggerDocWillClose 开始的值之一 （具有相同的前缀名称）。 如果当前附加操作是从PDF表单域构造的，触发器值必须是 从 FSDK.AdditionalAction.e_TriggerFieldKeyStroke 开始的值之一 （具有相同的前缀名称）。 如果当前附加操作是从PDF注释构造的，触发器值必须是 从 FSDK.AdditionalAction.e_TriggerAnnotCursorEnter 开始的值之一 （具有相同的前缀名称）。

返回
  一个操作对象。

## ◆ GetDict()

FSDK::AdditionalAction::GetDict | ( |  | ) |

获取当前对象的PDF字典。

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

## ◆ IsEmpty()

FSDK::AdditionalAction::IsEmpty | ( |  | ) |

检查当前对象是否为空。

When the current object is empty, that means current object is useless.

返回
  true means current object is empty, while false means not.

## ◆ RemoveAction()

FSDK::AdditionalAction::RemoveAction | ( | trigger |  | ) |

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

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

参数

  [in] | trigger | 输入的触发事件类型。它应该是: 如果当前附加操作是从PDF字典构造的，触发器值可以是 枚举类TriggerEvent中定义的值之一。 如果当前附加操作是从PDF页面构造的，触发器值必须是 从 FSDK.AdditionalAction.e_TriggerPageOpened 开始的值之一 （具有相同的前缀名称）。 如果当前附加操作是从PDF文档构造的，触发器值必须是 从 FSDK.AdditionalAction.e_TriggerDocWillClose 开始的值之一 （具有相同的前缀名称）。 如果当前附加操作是从PDF表单域构造的，触发器值必须是 从 FSDK.AdditionalAction.e_TriggerFieldKeyStroke 开始的值之一 （具有相同的前缀名称）。 如果当前附加操作是从PDF注释构造的，触发器值必须是 从 FSDK.AdditionalAction.e_TriggerAnnotCursorEnter 开始的值之一 （具有相同的前缀名称）。

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

## ◆ RemoveAllActions()

FSDK::AdditionalAction::RemoveAllActions | ( |  | ) |

移除所有操作。

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

## ◆ SetAction()

FSDK::AdditionalAction::SetAction | ( | trigger | ,
|  | action |
| ) |  |

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

参数

  [in] | trigger | 输入的触发事件类型。它应该是: 如果当前附加操作是从PDF字典构造的，触发器值可以是 枚举类TriggerEvent中定义的值之一。 如果当前附加操作是从PDF页面构造的，触发器值必须是 从 FSDK.AdditionalAction.e_TriggerPageOpened 开始的值之一 （具有相同的前缀名称）。 如果当前附加操作是从PDF文档构造的，触发器值必须是 从 FSDK.AdditionalAction.e_TriggerDocWillClose 开始的值之一 （具有相同的前缀名称）。 如果当前附加操作是从PDF表单域构造的，触发器值必须是 从 FSDK.AdditionalAction.e_TriggerFieldKeyStroke 开始的值之一 （具有相同的前缀名称）。 如果当前附加操作是从PDF注释构造的，触发器值必须是 从 FSDK.AdditionalAction.e_TriggerAnnotCursorEnter 开始的值之一 （具有相同的前缀名称）。
  [in] | action | 要设置的操作对象。 如果当前附加操作是从PDF文档或PDF表单域构造的，此操作的类型应为 FSDK.Action.e_TypeJavaScript。 如果当前附加操作是从PDF页面、PDF注释或PDF字典构造的， 请参阅触发事件的注释以检查是否只能使用指定类型的操作。 通常，支持以下类型作为新操作： FSDK.Action.e_TypeGoto, FSDK.Action.e_TypeURI, FSDK.Action.e_TypeJavaScript, FSDK.Action.e_TypeNamed, FSDK.Action.e_TypeGoToR, FSDK.Action.e_TypeGoToE, FSDK.Action.e_TypeSubmitForm, FSDK.Action.e_TypeResetForm, FSDK.Action.e_TypeHide, FSDK.Action.e_TypeLaunch, FSDK.Action.e_TypeImportData, FSDK.Action.e_TypeRendition。

返回
  无。

## 类成员变量说明

## ◆ e_TriggerAnnotCursorEnter

FSDK::AdditionalAction::e_TriggerAnnotCursorEnter
| static

当光标进入注释的活动区域时触发要执行的操作。

这表示注释附加操作字典中的"E"条目。 仅适用于从PDF注释构造的附加操作对象。

## ◆ e_TriggerAnnotCursorExit

FSDK::AdditionalAction::e_TriggerAnnotCursorExit
| static

当光标离开注释的活动区域时触发要执行的操作。

这表示注释附加操作字典中的"X"条目。 仅适用于从PDF注释构造的附加操作对象。

## ◆ e_TriggerAnnotLoseInputFocus

FSDK::AdditionalAction::e_TriggerAnnotLoseInputFocus
| static

(仅适用于小部件注释)当注释失去输入焦点时触发要执行的操作。

这表示注释附加操作字典中的"Bl"（大写B和小写L，代表"blurred"）条目。 仅适用于从小部件注释构造的附加操作对象。

## ◆ e_TriggerAnnotMouseButtonPressed

FSDK::AdditionalAction::e_TriggerAnnotMouseButtonPressed
| static

当在注释的活动区域内按下鼠标按钮时触发要执行的操作。

这表示注释附加操作字典中的"D"（代表"Down"）条目。 仅适用于从PDF注释构造的附加操作对象。

## ◆ e_TriggerAnnotMouseButtonReleased

FSDK::AdditionalAction::e_TriggerAnnotMouseButtonReleased
| static

当在注释的活动区域内释放鼠标按钮时触发要执行的操作。

这表示注释附加操作字典中的"U"（代表"Up"）条目。 仅适用于从PDF注释构造的附加操作对象。

## ◆ e_TriggerAnnotPageClosed

FSDK::AdditionalAction::e_TriggerAnnotPageClosed
| static

当包含注释的页面被关闭时触发要执行的操作。

这表示注释附加操作字典中的"PC"条目。 仅适用于从PDF注释构造的附加操作对象。 触发的操作在 FSDK.AdditionalAction.e_TriggerPageClosed 的操作之后执行（如果存在此类操作）。

## ◆ e_TriggerAnnotPageInvisible

FSDK::AdditionalAction::e_TriggerAnnotPageInvisible
| static

当包含注释的页面在查看器应用程序的用户界面中不再可见时触发要执行的操作。

这表示注释附加操作字典中的"PI"条目。 仅适用于从PDF注释构造的附加操作对象。

## ◆ e_TriggerAnnotPageOpened

FSDK::AdditionalAction::e_TriggerAnnotPageOpened
| static

当包含注释的页面被打开时触发要执行的操作。

这表示注释附加操作字典中的"PO"条目。 仅适用于从PDF注释构造的附加操作对象。 触发的操作在 FSDK.AdditionalAction.e_TriggerPageOpened 的操作 和PDF文档的打开操作之后执行（如果存在此类操作）。

## ◆ e_TriggerAnnotPageVisible

FSDK::AdditionalAction::e_TriggerAnnotPageVisible
| static

当包含注释的页面在查看器应用程序的用户界面中变得可见时触发要执行的操作。

这表示注释附加操作字典中的"PV"条目。 仅适用于从PDF注释构造的附加操作对象。

## ◆ e_TriggerAnnotReceiveInputFocus

FSDK::AdditionalAction::e_TriggerAnnotReceiveInputFocus
| static

(仅适用于小部件注释)当注释接收到输入焦点时触发要执行的操作。

这表示注释附加操作字典中的"Fo"条目。 仅适用于从小部件注释构造的附加操作对象。

## ◆ e_TriggerDocPrinted

FSDK::AdditionalAction::e_TriggerDocPrinted
| static

在打印文档之后触发要执行的JavaScript操作。

这表示文档目录附加操作字典中的"DP"条目。 仅适用于从PDF文档构造的附加操作对象。

## ◆ e_TriggerDocSaved

FSDK::AdditionalAction::e_TriggerDocSaved
| static

在保存文档之后触发要执行的JavaScript操作。

这表示文档目录附加操作字典中的"DS"条目。 仅适用于从PDF文档构造的附加操作对象。

## ◆ e_TriggerDocWillClose

FSDK::AdditionalAction::e_TriggerDocWillClose
| static

在关闭文档之前触发要执行的JavaScript操作。

这表示文档目录附加操作字典中的"WC"条目。 仅适用于从PDF文档构造的附加操作对象。

## ◆ e_TriggerDocWillPrint

FSDK::AdditionalAction::e_TriggerDocWillPrint
| static

在打印文档之前触发要执行的JavaScript操作。

这表示文档目录附加操作字典中的"WP"条目。 仅适用于从PDF文档构造的附加操作对象。

## ◆ e_TriggerDocWillSave

FSDK::AdditionalAction::e_TriggerDocWillSave
| static

在保存文档之前触发要执行的JavaScript操作。

这表示文档目录附加操作字典中的"WS"条目。 仅适用于从PDF文档构造的附加操作对象。

## ◆ e_TriggerFieldKeyStroke

FSDK::AdditionalAction::e_TriggerFieldKeyStroke
| static

当用户在文本域或组合框中键入键盘按键或修改可滚动列表框中的选择时触发要执行的JavaScript操作。

这表示表单域附加操作字典中的"K"条目。 仅适用于从PDF表单域构造的附加操作对象。
触发的操作可以检查键盘按键的有效性并拒绝或修改它。

## ◆ e_TriggerFieldRecalculateValue

FSDK::AdditionalAction::e_TriggerFieldRecalculateValue
| static

当另一个字段的值发生更改时，触发要执行的JavaScript操作以重新计算此字段的值。

这表示表单域附加操作字典中的"C"条目。 仅适用于从PDF表单域构造的附加操作对象。
可以通过函数 FSDK.Form.GetFieldsInCalculationOrder 获取文档字段重新计算的顺序。

## ◆ e_TriggerFieldValueChanged

FSDK::AdditionalAction::e_TriggerFieldValueChanged
| static

当字段的值被更改时触发要执行的JavaScript操作。

这表示表单域附加操作字典中的"V"条目。 仅适用于从PDF表单域构造的附加操作对象。
触发的操作可以检查新值的有效性。

## ◆ e_TriggerFieldWillFormat

FSDK::AdditionalAction::e_TriggerFieldWillFormat
| static

在格式化字段以显示其当前值之前触发要执行的JavaScript操作。

这表示表单域附加操作字典中的"F"条目。 仅适用于从PDF表单域构造的附加操作对象。
触发的操作可以在格式化之前修改字段的值。

## ◆ e_TriggerPageClosed

FSDK::AdditionalAction::e_TriggerPageClosed
| static

当页面关闭时触发要执行的操作。

这表示页面对象附加操作字典中的“C”条目。 仅适用于PDF页面构造的附加操作对象。

## ◆ e_TriggerPageOpened

FSDK::AdditionalAction::e_TriggerPageOpened
| static

Enumeration for trigger event.

Values of this enumeration should be used alone.

当页面打开时触发要执行的操作。

这表示页面对象附加操作字典中的“O”条目。 仅适用于PDF页面构造的附加操作对象。