Foxit PDF SDK
FSDK::SubmitFormAction类 参考
类 FSDK::SubmitFormAction 继承关系图:
FSDK::Action

Public 成员函数

 constructor (action)
 使用父类对象构造。 更多...
 
 GetFieldNames ()
 从当前提交表单操作中的数组获取所有字段名称。 更多...
 
 GetFlags ()
 获取用于提交的标志值。 更多...
 
 GetURL ()
 获取将处理提交的 Web 服务器上脚本的 URI 字符串。 更多...
 
 SetFieldNames (field_names)
 设置字段名称数组。 更多...
 
 SetFlags (flags)
 设置用于提交的标志值。 更多...
 
 SetURL (url)
 设置将处理提交的 Web 服务器上脚本的 URI 字符串。 更多...
 
- Public 成员函数 继承自 FSDK::Action
 constructor (document, action_dict)
 带参数的构造函数。 更多...
 
 GetDict ()
 获取当前对象的 PDF 字典。 更多...
 
 GetDocument ()
 获取当前操作所属的 PDF 文档。 更多...
 
 GetSubAction (index)
 通过索引获取子操作。 更多...
 
 GetSubActionCount ()
 获取子操作的数量。 更多...
 
 GetType ()
 获取操作类型。 更多...
 
 InsertSubAction (index, sub_action)
 将新子操作插入到索引指定的位置。 更多...
 
 IsEmpty ()
 检查当前对象是否为空。 更多...
 
 RemoveAllSubActions ()
 删除所有子操作。 更多...
 
 RemoveSubAction (index)
 删除由索引指定的子操作。 更多...
 
 SetSubAction (index, sub_action)
 通过索引设置子操作。 更多...
 

静态 Public 属性

static e_FlagAsXFDF
 位 6。字段名称和值以 XFDF 格式提交。
 
static e_FlagCanonicalFormat
 位 10。任何表示日期的提交字段值都会转换为标准格式。
 
static e_FlagEmbedForm
 位 14。提交的 FDF 的"F"条目是嵌入式文件流。
 
static e_FlagExclFKey
 位 12。提交的 FDF 排除"F"条目。
 
static e_FlagExclNonUserAnnots
 位 11。仅提交其"T"条目与当前用户名称匹配的那些标记注释。
 
static e_FlagExclude
 提交表单操作标志的枚举。 更多...
 
static e_FlagExportFormat
 位 3。以 HTML 表单格式提交字段名称和值。 更多...
 
static e_FlagGetMethod
 位 4。使用 HTTP GET 请求提交字段名称和值。 更多...
 
static e_FlagIncludeAnnotations
 位 8。提交的 FDF 文件包括底层 PDF 文档中的所有标记注释。 更多...
 
static e_FlagIncludeAppendSaves
 位 7。提交的 FDF 文件包括 FDF 字典中差异条目中包含的内容。 更多...
 
static e_FlagIncludeNoValueFields
 位 2。提交字段,无论它们是否有值。 更多...
 
static e_FlagSubmitAsPDF
 位 9。文档以 PDF 格式提交。
 
static e_FlagWithCoordinates
 位 5。鼠标坐标作为表单数据的一部分传输。
 
- 静态 Public 属性 继承自 FSDK::Action
static e_NewWindowFlagFalse
 新窗口标志的枚举。 更多...
 
static e_NewWindowFlagNone
 无"NewWindow"标志。
 
static e_NewWindowFlagTrue
 "NewWindow"标志为 true
 
static e_TypeGoto
 操作类型:跳转操作。
 
static e_TypeGoTo3DView
 操作类型:跳转到 3D 视图操作。
 
static e_TypeGoToE
 操作类型:嵌入式跳转操作。
 
static e_TypeGoToR
 操作类型:远程跳转操作。
 
static e_TypeHide
 操作类型:隐藏操作。
 
static e_TypeImportData
 操作类型:导入数据操作。
 
static e_TypeJavaScript
 操作类型:JavaScript 操作。
 
static e_TypeLaunch
 操作类型:启动操作。
 
static e_TypeMovie
 操作类型:影片操作。
 
static e_TypeNamed
 操作类型:命名操作。
 
static e_TypeRendition
 操作类型:演绎操作。
 
static e_TypeResetForm
 操作类型:重置表单操作。
 
static e_TypeSetOCGState
 操作类型:设置 OCG 状态操作。
 
static e_TypeSound
 操作类型:声音操作。
 
static e_TypeSubmitForm
 操作类型:提交表单操作。
 
static e_TypeThread
 操作类型:线程操作。
 
static e_TypeTrans
 操作类型:过渡操作。
 
static e_TypeUnknown
 操作类型的枚举。 更多...
 
static e_TypeURI
 操作类型:统一资源标识符 (URI) 操作。
 

额外继承的成员函数

- 静态 Public 成员函数 继承自 FSDK::Action
static Create (document, action_type)
 为指定的操作类型创建新操作。 更多...
 

详细描述

提交表单操作是将数据发送到统一资源定位符。 类 FSDK.SubmitFormActionFSDK.Action 派生,并提供函数来 获取/设置提交表单操作数据。

参见
FSDK.Action

成员函数说明

◆ constructor()

FSDK::SubmitFormAction::constructor ( action  )

使用父类对象构造。

参数
[in]action父类对象。

◆ GetFieldNames()

FSDK::SubmitFormAction::GetFieldNames ( )

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

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

返回
字段名称数组。

◆ GetFlags()

FSDK::SubmitFormAction::GetFlags ( )

获取用于提交的标志值。

返回
标志值。请参考从 FSDK.SubmitFormAction.e_FlagExclude 开始的值, 这将是这些值之一或这些值的组合。0 表示标志中的所有位都是 0。

◆ GetURL()

FSDK::SubmitFormAction::GetURL ( )

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

返回
URI 字符串。

◆ SetFieldNames()

FSDK::SubmitFormAction::SetFieldNames ( field_names  )

设置字段名称数组。

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

参数
[in]field_names表单字段名称的数组,用于标识要 包含在提交中或从提交中排除的字段。此参数可以是空数组。 字段名称可以通过函数 FSDK.Field.GetName 检索。
返回
无。

◆ SetFlags()

FSDK::SubmitFormAction::SetFlags ( flags  )

设置用于提交的标志值。

参数
[in]flags新标志值。请参考从 FSDK.SubmitFormAction.e_FlagExclude 开始的值, 这可以是这些值之一或这些值的组合。 也可以是 0,这意味着标志中的所有位都是 0。
返回
无。

◆ SetURL()

FSDK::SubmitFormAction::SetURL ( url  )

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

参数
[in]urlURI 字符串。它不应为空字符串。
返回
无。

类成员变量说明

◆ e_FlagExclude

FSDK::SubmitFormAction::e_FlagExclude
static

提交表单操作标志的枚举。

此枚举的值可以单独使用或组合使用。位 1。如果设置,提交表单操作中定义的字段名称应从提交中排除; 如果未设置,则仅提交这些字段名称(包括其后代)。

◆ e_FlagExportFormat

FSDK::SubmitFormAction::e_FlagExportFormat
static

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

注解
仅在标志 FSDK.SubmitFormAction.e_FlagAsXFDFFSDK.SubmitFormAction.e_FlagSubmitAsPDF 清除时才有意义。
如果此标志清除,则表示以表单数据格式 (FDF) 提交。

◆ e_FlagGetMethod

FSDK::SubmitFormAction::e_FlagGetMethod
static

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

注解
仅当标志 FSDK.SubmitFormAction.e_FlagExportFormat 设置时才有意义。如果此标志清除,则表示使用 POST 请求提交。

◆ e_FlagIncludeAnnotations

FSDK::SubmitFormAction::e_FlagIncludeAnnotations
static

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

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

◆ e_FlagIncludeAppendSaves

FSDK::SubmitFormAction::e_FlagIncludeAppendSaves
static

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

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

◆ e_FlagIncludeNoValueFields

FSDK::SubmitFormAction::e_FlagIncludeNoValueFields
static

位 2。提交字段,无论它们是否有值。

注解
对于没有值的字段,仅传输字段名称。