Foxit PDF SDK

Public 类型 | Public 成员函数 | 静态 Public 成员函数 | 所有成员列表
foxit.pdf.actions.Action类 参考
类 foxit.pdf.actions.Action 继承关系图:

## Public 类型
enum | NewWindowFlag { NewWindowFlag.e_NewWindowFlagFalse = 0, NewWindowFlag.e_NewWindowFlagTrue = 1, NewWindowFlag.e_NewWindowFlagNone = 2 }
| 新窗口标志枚举。 更多...
enum | Type { Type.e_TypeUnknown = 0, Type.e_TypeGoto = 1, Type.e_TypeGoToR = 2, Type.e_TypeGoToE = 3, Type.e_TypeLaunch = 4, Type.e_TypeThread = 5, Type.e_TypeURI = 6, Type.e_TypeSound = 7, Type.e_TypeMovie = 8, Type.e_TypeHide = 9, Type.e_TypeNamed = 10, Type.e_TypeSubmitForm = 11, Type.e_TypeResetForm = 12, Type.e_TypeImportData = 13, Type.e_TypeJavaScript = 14, Type.e_TypeSetOCGState = 15, Type.e_TypeRendition = 16, Type.e_TypeTrans = 17, Type.e_TypeGoTo3DView = 18 }
| 动作类型枚举。 更多...

## Public 成员函数
| Action (PDFDoc document, PDFDictionary action_dict)
| 构造函数，带参数。 更多...
| Action (Action action)
| 构造函数，使用另一个动作对象。 更多...
PDFDictionary | GetDict ()
| 获取当前对象的PDF字典。 更多...
PDFDoc | GetDocument ()
| 获取当前动作所属的PDF文档。 更多...
Action | GetSubAction (int index)
| 按索引获取子动作。 更多...
int | GetSubActionCount ()
| 获取子动作的数量。 更多...
Action.Type | GetType ()
| 获取动作类型。 更多...
void | InsertSubAction (int index, Action sub_action)
| 在指定索引位置插入新的子动作。 更多...
bool | IsEmpty ()
| 检查当前对象是否为空。 更多...
void | RemoveAllSubActions ()
| 移除所有子动作。 更多...
void | RemoveSubAction (int index)
| 移除指定索引的子动作。 更多...
void | SetSubAction (int index, Action sub_action)
| 按索引设置子动作。 更多...

## 静态 Public 成员函数
static Action | Create (PDFDoc document, Action.Type action_type)
| 为指定的动作类型创建新动作。 更多...

## 详细描述

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

## 成员枚举类型说明

## ◆ NewWindowFlag

enum foxit.pdf.actions.Action.NewWindowFlag
| strong

新窗口标志枚举。

此枚举的值应单独使用。

枚举值
e_NewWindowFlagFalse | "NewWindow"标志为false。
e_NewWindowFlagTrue | "NewWindow"标志为true。
e_NewWindowFlagNone | 无"NewWindow"标志。

## ◆ Type

enum foxit.pdf.actions.Action.Type
| strong

动作类型枚举。

此枚举的值应单独使用。

枚举值
e_TypeUnknown | 动作类型：未知动作。
e_TypeGoto | 动作类型：转到动作。
e_TypeGoToR | 动作类型：远程转到动作。
e_TypeGoToE | 动作类型：嵌入转到动作。
e_TypeLaunch | 动作类型：启动动作。
e_TypeThread | 动作类型：线程动作。
e_TypeURI | 动作类型：统一资源标识符(URI)动作。
e_TypeSound | 动作类型：声音动作。
e_TypeMovie | 动作类型：电影动作。
e_TypeHide | 动作类型：隐藏动作。
e_TypeNamed | 动作类型：命名动作。
e_TypeSubmitForm | 动作类型：提交表单动作。
e_TypeResetForm | 动作类型：重置表单动作。
e_TypeImportData | 动作类型：导入数据动作。
e_TypeJavaScript | 动作类型：JavaScript动作。
e_TypeSetOCGState | 动作类型：设置OCG状态动作。
e_TypeRendition | 动作类型：演示动作。
e_TypeTrans | 动作类型：过渡动作。
e_TypeGoTo3DView | 动作类型：转到3D视图动作。

## 构造及析构函数说明

## ◆ Action() [1/2]

foxit.pdf.actions.Action.Action | ( | PDFDoc | document,
|  | PDFDictionary | action_dict
| ) |  |
| inline

构造函数，带参数。

参数

  [in] | document | 有效的PDF文档对象。
  [in] | action_dict | 表示动作的PDF字典对象。

## ◆ Action() [2/2]

foxit.pdf.actions.Action.Action | ( | Action | action | ) |
| inline

构造函数，使用另一个动作对象。

参数

  [in] | action | 另一个动作对象。

## 成员函数说明

## ◆ Create()

static Action foxit.pdf.actions.Action.Create | ( | PDFDoc | document,
|  | Action.Type | action_type
| ) |  |
| inline static

为指定的动作类型创建新动作。

新创建的动作尚未有动作数据（除了动作类型）。 用户需要调用具体动作类中的函数来设置动作数据。

参数

  [in] | document | 新动作所属的有效PDF文档。
  [in] | action_type | 动作类型，用于指定要创建的动作类型。 目前仅支持： foxit.pdf.actions.Action.Type.e_TypeGoto 、foxit.pdf.actions.Action.Type.e_TypeURI 、 foxit.pdf.actions.Action.Type.e_TypeJavaScript 、foxit.pdf.actions.Action.Type.e_TypeNamed 、 foxit.pdf.actions.Action.Type.e_TypeGoToR 、foxit.pdf.actions.Action.Type.e_TypeGoToE 、 foxit.pdf.actions.Action.Type.e_TypeSubmitForm 、foxit.pdf.actions.Action.Type.e_TypeResetForm 、 foxit.pdf.actions.Action.Type.e_TypeHide 、foxit.pdf.actions.Action.Type.e_TypeLaunch 、 foxit.pdf.actions.Action.Type.e_TypeImportData 、foxit.pdf.actions.Action.Type.e_TypeRendition 、 foxit.pdf.actions.Action.Type.e_TypeSetOCGState 、foxit.pdf.actions.Action.Type.e_TypeThread ，

返回
  没有动作数据的新动作对象。

## ◆ GetDict()

PDFDictionary foxit.pdf.actions.Action.GetDict | ( |  | ) |
| inline

获取当前对象的PDF字典。

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

## ◆ GetDocument()

PDFDoc foxit.pdf.actions.Action.GetDocument | ( |  | ) |
| inline

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

返回
  PDF文档对象。

## ◆ GetSubAction()

Action foxit.pdf.actions.Action.GetSubAction | ( | int | index | ) |
| inline

按索引获取子动作。

参数

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

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

## ◆ GetSubActionCount()

int foxit.pdf.actions.Action.GetSubActionCount | ( |  | ) |
| inline

获取子动作的数量。

返回
  子动作的数量。

## ◆ GetType()

Action.Type foxit.pdf.actions.Action.GetType | ( |  | ) |
| inline

获取动作类型。

返回
  动作类型。请参考从foxit.pdf.actions.Action.Type.e_TypeGoto 开始的值， 这将是这些值中的一个。

## ◆ InsertSubAction()

void foxit.pdf.actions.Action.InsertSubAction | ( | int | index,
|  | Action | sub_action
| ) |  |
| inline

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

参数

  [in] | index | 要插入新子动作的位置索引。 如果此索引值小于零，新子动作将被插入为第一个。 如果此索引值等于或大于当前子动作数量，新子动作将 被插入为最后一个。
  [in] | sub_action | 要插入的新子动作。当前仅支持以下类型 作为新子动作： foxit.pdf.actions.Action.Type.e_TypeGoto ，foxit.pdf.actions.Action.Type.e_TypeURI ， foxit.pdf.actions.Action.Type.e_TypeJavaScript ，foxit.pdf.actions.Action.Type.e_TypeNamed ， foxit.pdf.actions.Action.Type.e_TypeGoToR ，foxit.pdf.actions.Action.Type.e_TypeGoToE ， foxit.pdf.actions.Action.Type.e_TypeSubmitForm ，foxit.pdf.actions.Action.Type.e_TypeResetForm ， foxit.pdf.actions.Action.Type.e_TypeHide ，foxit.pdf.actions.Action.Type.e_TypeLaunch ， foxit.pdf.actions.Action.Type.e_TypeImportData ，foxit.pdf.actions.Action.Type.e_TypeRendition 。

返回
  无。

## ◆ IsEmpty()

bool foxit.pdf.actions.Action.IsEmpty | ( |  | ) |
| inline

检查当前对象是否为空。

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

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

## ◆ RemoveAllSubActions()

void foxit.pdf.actions.Action.RemoveAllSubActions | ( |  | ) |
| inline

移除所有子动作。

返回
  无。

## ◆ RemoveSubAction()

void foxit.pdf.actions.Action.RemoveSubAction | ( | int | index | ) |
| inline

移除指定索引的子动作。

参数

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

返回
  无。

## ◆ SetSubAction()

void foxit.pdf.actions.Action.SetSubAction | ( | int | index,
|  | Action | sub_action
| ) |  |
| inline

按索引设置子动作。

参数

  [in] | index | 要检索的子动作的索引。有效范围：从0到(count-1)。 count由函数Action.GetSubActionCount 返回。
  [in] | sub_action | 要设置为子动作的动作对象。目前仅支持以下类型 作为子动作： foxit.pdf.actions.Action.Type.e_TypeGoto 、foxit.pdf.actions.Action.Type.e_TypeURI 、 foxit.pdf.actions.Action.Type.e_TypeJavaScript 、foxit.pdf.actions.Action.Type.e_TypeNamed 、 foxit.pdf.actions.Action.Type.e_TypeGoToR 、foxit.pdf.actions.Action.Type.e_TypeGoToE 、 foxit.pdf.actions.Action.Type.e_TypeSubmitForm 、foxit.pdf.actions.Action.Type.e_TypeResetForm 、 foxit.pdf.actions.Action.Type.e_TypeHide 、foxit.pdf.actions.Action.Type.e_TypeLaunch 、 foxit.pdf.actions.Action.Type.e_TypeImportData 、foxit.pdf.actions.Action.Type.e_TypeRendition 、 foxit.pdf.actions.Action.Type.e_TypeSetOCGState 。

返回
  无。