Foxit PDF SDK

Public 成员函数 | 静态 Public 属性 | 所有成员列表
com.foxit.sdk.pdf.actions.SubmitFormAction类 参考
类 com.foxit.sdk.pdf.actions.SubmitFormAction 继承关系图:

## Public 成员函数
| SubmitFormAction (Action action)
| 构造函数，使用父类对象。 更多...
synchronized void | delete ()
| 直接清除C++相关资源。 更多...
WStringArray | getFieldNames () throws com.foxit.sdk.PDFException
| 从当前提交表单动作的数组中获取所有字段名称。 更多...
int | getFlags () throws com.foxit.sdk.PDFException
| 获取用于提交的标志值。 更多...
String | getURL () throws com.foxit.sdk.PDFException
| 获取Web服务器上处理提交的脚本的URI字符串。 更多...
void | setFieldNames (WStringArray field_names) throws com.foxit.sdk.PDFException
| 设置字段名称数组。 更多...
void | setFlags (int flags) throws com.foxit.sdk.PDFException
| 设置用于提交的标志值。 更多...
void | setURL (String url) throws com.foxit.sdk.PDFException
| 设置Web服务器上处理提交的脚本的URI字符串。 更多...
Public 成员函数 继承自 com.foxit.sdk.pdf.actions.Action
| Action (Action action)
| 构造函数，使用另一个动作对象。 更多...
| Action (PDFDoc document, PDFDictionary action_dict)
| 构造函数，带参数。 更多...
PDFDictionary | getDict () throws com.foxit.sdk.PDFException
| 获取当前对象的PDF字典。 更多...
PDFDoc | getDocument () throws com.foxit.sdk.PDFException
| 获取当前动作所属的PDF文档。 更多...
Action | getSubAction (int index) throws com.foxit.sdk.PDFException
| 按索引获取子动作。 更多...
int | getSubActionCount () throws com.foxit.sdk.PDFException
| 获取子动作的数量。 更多...
int | getType () throws com.foxit.sdk.PDFException
| 获取动作类型。 更多...
void | insertSubAction (int index, Action sub_action) throws com.foxit.sdk.PDFException
| 在指定索引位置插入新的子动作。 更多...
boolean | isEmpty ()
| 检查当前对象是否为空。 更多...
void | removeAllSubActions () throws com.foxit.sdk.PDFException
| 移除所有子动作。 更多...
void | removeSubAction (int index) throws com.foxit.sdk.PDFException
| 移除指定索引的子动作。 更多...
void | setSubAction (int index, Action sub_action) throws com.foxit.sdk.PDFException
| 按索引设置子动作。 更多...

## 静态 Public 属性
static final int | e_FlagAsXFDF = 0x0020
| 位6。字段名称和值以XFDF格式提交。
static final int | e_FlagCanonicalFormat = 0x0200
| 位10。任何表示日期的提交字段值都转换为标准格式。
static final int | e_FlagEmbedForm = 0x2000
| 位14。提交的FDF的"F"条目是嵌入文件流。
static final int | e_FlagExclFKey = 0x0800
| 位12。提交的FDF排除"F"条目。
static final int | e_FlagExclNonUserAnnots = 0x0400
| 位11。只有那些"T"条目与当前用户名称匹配的标记注释 才被提交。
static final int | e_FlagExclude = 0x0001
| 位1。如果设置，提交表单动作中定义的字段名称应从提交中排除； 如果未设置，则只有这些字段名称（包括其后代）将被提交。
static final int | e_FlagExportFormat = 0x0004
| 位3。字段名称和值以HTML表单格式提交。 更多...
static final int | e_FlagGetMethod = 0x0008
| 位4。字段名称和值使用HTTP GET请求提交。 更多...
static final int | e_FlagIncludeAnnotations = 0x0080
| 位8。提交的FDF文件包含底层PDF文档中的所有标记注释。 更多...
static final int | e_FlagIncludeAppendSaves = 0x0040
| 位7。提交的FDF文件包含FDF字典中差异条目包含的内容。 更多...
static final int | e_FlagIncludeNoValueFields = 0x0002
| 位2。无论字段是否有值都提交字段。 更多...
static final int | e_FlagSubmitAsPDF = 0x0100
| 位9。文档以PDF格式提交。
static final int | e_FlagWithCoordinates = 0x0010
| 位5。鼠标坐标作为表单数据的一部分传输。
静态 Public 属性 继承自 com.foxit.sdk.pdf.actions.Action
static final int | e_NewWindowFlagFalse = 0
| "NewWindow"标志为false。
static final int | e_NewWindowFlagNone = 2
| 无"NewWindow"标志。
static final int | e_NewWindowFlagTrue = 1
| "NewWindow"标志为true。
static final int | e_TypeGoto = 1
| 动作类型：转到动作。
static final int | e_TypeGoTo3DView = 18
| 动作类型：转到3D视图动作。
static final int | e_TypeGoToE = 3
| 动作类型：嵌入转到动作。
static final int | e_TypeGoToR = 2
| 动作类型：远程转到动作。
static final int | e_TypeHide = 9
| 动作类型：隐藏动作。
static final int | e_TypeImportData = 13
| 动作类型：导入数据动作。
static final int | e_TypeJavaScript = 14
| 动作类型：JavaScript动作。
static final int | e_TypeLaunch = 4
| 动作类型：启动动作。
static final int | e_TypeMovie = 8
| 动作类型：电影动作。
static final int | e_TypeNamed = 10
| 动作类型：命名动作。
static final int | e_TypeRendition = 16
| 动作类型：演示动作。
static final int | e_TypeResetForm = 12
| 动作类型：重置表单动作。
static final int | e_TypeSetOCGState = 15
| 动作类型：设置OCG状态动作。
static final int | e_TypeSound = 7
| 动作类型：声音动作。
static final int | e_TypeSubmitForm = 11
| 动作类型：提交表单动作。
static final int | e_TypeThread = 5
| 动作类型：线程动作。
static final int | e_TypeTrans = 17
| 动作类型：过渡动作。
static final int | e_TypeUnknown = 0
| 动作类型：未知动作。
static final int | e_TypeURI = 6
| 动作类型：统一资源标识符(URI)动作。

## 额外继承的成员函数
静态 Public 成员函数 继承自 com.foxit.sdk.pdf.actions.Action
static Action | create (PDFDoc document, int action_type) throws com.foxit.sdk.PDFException
| 为指定的动作类型创建新动作。 更多...

## 详细描述

提交表单动作是将数据发送到统一资源定位符。 类com.foxit.sdk.pdf.actions.SubmitFormAction 派生自Action ，提供用于 获取/设置提交表单动作数据的函数。

参见
  Action

## 构造及析构函数说明

## ◆ SubmitFormAction()

com.foxit.sdk.pdf.actions.SubmitFormAction.SubmitFormAction | ( | Action | action | ) |

构造函数，使用父类对象。

参数

  [in] | action | 父类对象。

## 成员函数说明

## ◆ delete()

synchronized void com.foxit.sdk.pdf.actions.SubmitFormAction.delete | ( |  | ) |

直接清除C++相关资源。

返回
  无。

注解
  一旦这个接口被调用，这个对象将不能再被使用。

重载 com.foxit.sdk.pdf.actions.Action .

## ◆ getFieldNames()

WStringArray com.foxit.sdk.pdf.actions.SubmitFormAction.getFieldNames | ( |  | ) | throws com.foxit.sdk.PDFException

从当前提交表单动作的数组中获取所有字段名称。

提交表单动作可以有一个数组，标识要在提交中包含哪些字段或 要排除哪些字段，具体取决于标志值。

返回
  字段名称数组。

## ◆ getFlags()

int com.foxit.sdk.pdf.actions.SubmitFormAction.getFlags | ( |  | ) | throws com.foxit.sdk.PDFException

获取用于提交的标志值。

返回
  标志值。请参考从com.foxit.sdk.pdf.actions.SubmitFormAction.e_FlagExclude 开始的值， 这将是这些值中的一个或组合。0表示标志中的所有位都是0。

## ◆ getURL()

String com.foxit.sdk.pdf.actions.SubmitFormAction.getURL | ( |  | ) | throws com.foxit.sdk.PDFException

获取Web服务器上处理提交的脚本的URI字符串。

返回
  URI字符串。

## ◆ setFieldNames()

void com.foxit.sdk.pdf.actions.SubmitFormAction.setFieldNames | ( | WStringArray | field_names | ) | throws com.foxit.sdk.PDFException

设置字段名称数组。

提交表单动作可以有一个数组，标识要在提交中包含哪些字段或 要排除哪些字段，具体取决于标志值。

参数

  [in] | field_names | 表单字段名称的数组，用于标识要在提交中包含或排除的字段。 此参数可以是空数组。 字段名称可以通过函数interform.Field.getName 获取。

返回
  无。

## ◆ setFlags()

void com.foxit.sdk.pdf.actions.SubmitFormAction.setFlags | ( | int | flags | ) | throws com.foxit.sdk.PDFException

设置用于提交的标志值。

参数

  [in] | flags | 新的标志值。请参考从com.foxit.sdk.pdf.actions.SubmitFormAction.e_FlagExclude 开始的值， 这可以是这些值中的一个或组合。 也可以是0，表示标志中的所有位都是0。

返回
  无。

## ◆ setURL()

void com.foxit.sdk.pdf.actions.SubmitFormAction.setURL | ( | String | url | ) | throws com.foxit.sdk.PDFException

设置Web服务器上处理提交的脚本的URI字符串。

参数

  [in] | url | URI字符串。不应为空字符串。

返回
  无。

## 类成员变量说明

## ◆ e_FlagExportFormat

final int com.foxit.sdk.pdf.actions.SubmitFormAction.e_FlagExportFormat = 0x0004
| static

位3。字段名称和值以HTML表单格式提交。

注解
  仅在标志com.foxit.sdk.pdf.actions.SubmitFormAction.e_FlagAsXFDF 和 com.foxit.sdk.pdf.actions.SubmitFormAction.e_FlagSubmitAsPDF 未设置时有意义。
  如果此标志未设置，则表示以表单数据格式(FDF)提交。

## ◆ e_FlagGetMethod

final int com.foxit.sdk.pdf.actions.SubmitFormAction.e_FlagGetMethod = 0x0008
| static

位4。字段名称和值使用HTTP GET请求提交。

注解
  仅在设置标志com.foxit.sdk.pdf.actions.SubmitFormAction.e_FlagExportFormat 时有意义。 如果此标志未设置，则表示使用POST请求提交。

## ◆ e_FlagIncludeAnnotations

final int com.foxit.sdk.pdf.actions.SubmitFormAction.e_FlagIncludeAnnotations = 0x0080
| static

位8。提交的FDF文件包含底层PDF文档中的所有标记注释。

注解
  仅在表单以表单数据格式提交时有意义。

## ◆ e_FlagIncludeAppendSaves

final int com.foxit.sdk.pdf.actions.SubmitFormAction.e_FlagIncludeAppendSaves = 0x0040
| static

位7。提交的FDF文件包含FDF字典中差异条目包含的内容。

注解
  仅在表单以表单数据格式提交时有意义。

## ◆ e_FlagIncludeNoValueFields

final int com.foxit.sdk.pdf.actions.SubmitFormAction.e_FlagIncludeNoValueFields = 0x0002
| static

位2。无论字段是否有值都提交字段。

注解
  对于没有值的字段，只传输字段名称。