Foxit PDF SDK

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

## Public 成员函数
def | SubmitFormAction (action)
| 构造函数，使用父类对象。 更多...
def | GetFieldNames ()
| 从当前提交表单动作的数组中获取所有字段名称。 更多...
def | GetFlags ()
| 获取用于提交的标志值。 更多...
def | GetURL ()
| 获取Web服务器上处理提交的脚本的URI字符串。 更多...
def | SetFieldNames (field_names)
| 设置字段名称数组。 更多...
def | SetFlags (flags)
| 设置用于提交的标志值。 更多...
def | SetURL (url)
| 设置Web服务器上处理提交的脚本的URI字符串。 更多...
Public 成员函数 继承自 FoxitPDFSDKPython3.Action
def | Action (action)
| 构造函数，使用另一个动作对象。 更多...
def | GetDict ()
| 获取当前对象的PDF字典。 更多...
def | GetDocument ()
| 获取当前动作所属的PDF文档。 更多...
def | GetSubAction (index)
| 按索引获取子动作。 更多...
def | GetSubActionCount ()
| 获取子动作的数量。 更多...
def | GetType ()
| 获取动作类型。 更多...
def | InsertSubAction (index, sub_action)
| 在指定索引位置插入新的子动作。 更多...
def | IsEmpty ()
| 检查当前对象是否为空。 更多...
def | RemoveAllSubActions ()
| 移除所有子动作。 更多...
def | RemoveSubAction (index)
| 移除指定索引的子动作。 更多...
def | SetSubAction (index, sub_action)
| 按索引设置子动作。 更多...

## 静态 Public 属性
| e_FlagAsXFDF = _fsdk.SubmitFormAction_e_FlagAsXFDF
| 位6。字段名称和值以XFDF格式提交。
| e_FlagCanonicalFormat = _fsdk.SubmitFormAction_e_FlagCanonicalFormat
| 位10。任何表示日期的提交字段值都转换为标准格式。
| e_FlagEmbedForm = _fsdk.SubmitFormAction_e_FlagEmbedForm
| 位14。提交的FDF的"F"条目是嵌入文件流。
| e_FlagExclFKey = _fsdk.SubmitFormAction_e_FlagExclFKey
| 位12。提交的FDF排除"F"条目。
| e_FlagExclNonUserAnnots = _fsdk.SubmitFormAction_e_FlagExclNonUserAnnots
| 位11。只有那些"T"条目与当前用户名称匹配的标记注释 才被提交。
| e_FlagExclude = _fsdk.SubmitFormAction_e_FlagExclude
| 位1。如果设置，提交表单动作中定义的字段名称应从提交中排除； 如果未设置，则只有这些字段名称（包括其后代）将被提交。
| e_FlagExportFormat = _fsdk.SubmitFormAction_e_FlagExportFormat
| 位3。字段名称和值以HTML表单格式提交。 更多...
| e_FlagGetMethod = _fsdk.SubmitFormAction_e_FlagGetMethod
| 位4。字段名称和值使用HTTP GET请求提交。 更多...
| e_FlagIncludeAnnotations = _fsdk.SubmitFormAction_e_FlagIncludeAnnotations
| 位8。提交的FDF文件包含底层PDF文档中的所有标记注释。 更多...
| e_FlagIncludeAppendSaves = _fsdk.SubmitFormAction_e_FlagIncludeAppendSaves
| 位7。提交的FDF文件包含FDF字典中差异条目包含的内容。 更多...
| e_FlagIncludeNoValueFields = _fsdk.SubmitFormAction_e_FlagIncludeNoValueFields
| 位2。无论字段是否有值都提交字段。 更多...
| e_FlagSubmitAsPDF = _fsdk.SubmitFormAction_e_FlagSubmitAsPDF
| 位9。文档以PDF格式提交。
| e_FlagWithCoordinates = _fsdk.SubmitFormAction_e_FlagWithCoordinates
| 位5。鼠标坐标作为表单数据的一部分传输。
静态 Public 属性 继承自 FoxitPDFSDKPython3.Action
| e_NewWindowFlagFalse = _fsdk.Action_e_NewWindowFlagFalse
| "NewWindow"标志为false。
| e_NewWindowFlagNone = _fsdk.Action_e_NewWindowFlagNone
| 无"NewWindow"标志。
| e_NewWindowFlagTrue = _fsdk.Action_e_NewWindowFlagTrue
| "NewWindow"标志为true。
| e_TypeGoto = _fsdk.Action_e_TypeGoto
| 动作类型：转到动作。
| e_TypeGoTo3DView = _fsdk.Action_e_TypeGoTo3DView
| 动作类型：转到3D视图动作。
| e_TypeGoToE = _fsdk.Action_e_TypeGoToE
| 动作类型：嵌入转到动作。
| e_TypeGoToR = _fsdk.Action_e_TypeGoToR
| 动作类型：远程转到动作。
| e_TypeHide = _fsdk.Action_e_TypeHide
| 动作类型：隐藏动作。
| e_TypeImportData = _fsdk.Action_e_TypeImportData
| 动作类型：导入数据动作。
| e_TypeJavaScript = _fsdk.Action_e_TypeJavaScript
| 动作类型：JavaScript动作。
| e_TypeLaunch = _fsdk.Action_e_TypeLaunch
| 动作类型：启动动作。
| e_TypeMovie = _fsdk.Action_e_TypeMovie
| 动作类型：电影动作。
| e_TypeNamed = _fsdk.Action_e_TypeNamed
| 动作类型：命名动作。
| e_TypeRendition = _fsdk.Action_e_TypeRendition
| 动作类型：演示动作。
| e_TypeResetForm = _fsdk.Action_e_TypeResetForm
| 动作类型：重置表单动作。
| e_TypeSetOCGState = _fsdk.Action_e_TypeSetOCGState
| 动作类型：设置OCG状态动作。
| e_TypeSound = _fsdk.Action_e_TypeSound
| 动作类型：声音动作。
| e_TypeSubmitForm = _fsdk.Action_e_TypeSubmitForm
| 动作类型：提交表单动作。
| e_TypeThread = _fsdk.Action_e_TypeThread
| 动作类型：线程动作。
| e_TypeTrans = _fsdk.Action_e_TypeTrans
| 动作类型：过渡动作。
| e_TypeUnknown = _fsdk.Action_e_TypeUnknown
| 动作类型：未知动作。
| e_TypeURI = _fsdk.Action_e_TypeURI
| 动作类型：统一资源标识符(URI)动作。

## 额外继承的成员函数
静态 Public 成员函数 继承自 FoxitPDFSDKPython3.Action
def | Create (document, action_type)
| 为指定的动作类型创建新动作。 更多...

## 详细描述

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

参见
  Action

## 构造及析构函数说明

## ◆ SubmitFormAction()

def FoxitPDFSDKPython3.SubmitFormAction.SubmitFormAction | ( |  | action | ) |

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

参数

  [in] | action | 父类对象。

## 成员函数说明

## ◆ GetFieldNames()

def FoxitPDFSDKPython3.SubmitFormAction.GetFieldNames | ( |  | ) |

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

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

返回
  字段名称数组。

## ◆ GetFlags()

def FoxitPDFSDKPython3.SubmitFormAction.GetFlags | ( |  | ) |

获取用于提交的标志值。

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

## ◆ GetURL()

def FoxitPDFSDKPython3.SubmitFormAction.GetURL | ( |  | ) |

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

返回
  URI字符串。

## ◆ SetFieldNames()

def FoxitPDFSDKPython3.SubmitFormAction.SetFieldNames | ( |  | field_names | ) |

设置字段名称数组。

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

参数

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

返回
  无。

## ◆ SetFlags()

def FoxitPDFSDKPython3.SubmitFormAction.SetFlags | ( |  | flags | ) |

设置用于提交的标志值。

参数

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

返回
  无。

## ◆ SetURL()

def FoxitPDFSDKPython3.SubmitFormAction.SetURL | ( |  | url | ) |

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

参数

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

返回
  无。

## 类成员变量说明

## ◆ e_FlagExportFormat

FoxitPDFSDKPython3.SubmitFormAction.e_FlagExportFormat = _fsdk.SubmitFormAction_e_FlagExportFormat
| static

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

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

## ◆ e_FlagGetMethod

FoxitPDFSDKPython3.SubmitFormAction.e_FlagGetMethod = _fsdk.SubmitFormAction_e_FlagGetMethod
| static

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

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

## ◆ e_FlagIncludeAnnotations

FoxitPDFSDKPython3.SubmitFormAction.e_FlagIncludeAnnotations = _fsdk.SubmitFormAction_e_FlagIncludeAnnotations
| static

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

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

## ◆ e_FlagIncludeAppendSaves

FoxitPDFSDKPython3.SubmitFormAction.e_FlagIncludeAppendSaves = _fsdk.SubmitFormAction_e_FlagIncludeAppendSaves
| static

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

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

## ◆ e_FlagIncludeNoValueFields

FoxitPDFSDKPython3.SubmitFormAction.e_FlagIncludeNoValueFields = _fsdk.SubmitFormAction_e_FlagIncludeNoValueFields
| static

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

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