类 foxit::pdf::actions::SubmitFormAction 继承关系图:

Public 类型
enum	Flags { e_FlagExclude = 0x0001, e_FlagIncludeNoValueFields = 0x0002, e_FlagExportFormat = 0x0004, e_FlagGetMethod = 0x0008, e_FlagWithCoordinates = 0x0010, e_FlagAsXFDF = 0x0020, e_FlagIncludeAppendSaves = 0x0040, e_FlagIncludeAnnotations = 0x0080, e_FlagSubmitAsPDF = 0x0100, e_FlagCanonicalFormat = 0x0200, e_FlagExclNonUserAnnots = 0x0400, e_FlagExclFKey = 0x0800, e_FlagEmbedForm = 0x2000 }
	提交表单动作标志的枚举。更多...

Public 类型继承自 foxit::pdf::actions::Action
enum	NewWindowFlag { e_NewWindowFlagFalse = 0, e_NewWindowFlagTrue = 1, e_NewWindowFlagNone = 2 }
	新窗口标志枚举。更多...

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

Public 成员函数
	SubmitFormAction (const Action &action)
	构造函数，使用父类对象。更多...

WStringArray	GetFieldNames ()
	从当前提交表单动作的数组中获取所有字段名称。更多...

uint32	GetFlags ()
	获取用于提交的标志值。更多...

String	GetURL ()
	获取Web服务器上处理提交的脚本的URI字符串。更多...

void	SetFieldNames (const WStringArray &field_names)
	设置字段名称数组。更多...

void	SetFlags (uint32 flags)
	设置用于提交的标志值。更多...

void	SetURL (const String &url)
	设置Web服务器上处理提交的脚本的URI字符串。更多...

Public 成员函数继承自 foxit::pdf::actions::Action
	Action (const PDFDoc &document, objects::PDFDictionary *action_dict)
	构造函数，带参数。更多...

	Action (const Action &action)
	构造函数，使用另一个动作对象。更多...

	~Action ()
	析构函数。

objects::PDFDictionary *	GetDict () const
	获取当前对象的PDF字典。更多...

PDFDoc	GetDocument ()
	获取当前动作所属的PDF文档。更多...

Action	GetSubAction (int index)
	按索引获取子动作。更多...

int	GetSubActionCount ()
	获取子动作的数量。更多...

Type	GetType ()
	获取动作类型。更多...

void	InsertSubAction (int index, const Action &sub_action)
	在指定索引位置插入新的子动作。更多...

bool	IsEmpty () const
	检查当前对象是否为空。更多...

bool	operator != (const Action &other) const
	不等于操作符。更多...

Action &	operator= (const Action &other)
	赋值操作符。更多...

bool	operator== (const Action &other) const
	等于操作符。更多...

void	RemoveAllSubActions ()
	移除所有子动作。更多...

void	RemoveSubAction (int index)
	移除指定索引的子动作。更多...

void	SetSubAction (int index, const Action &sub_action)
	按索引设置子动作。更多...

Public 成员函数继承自 foxit::Base
FS_HANDLE	Handle () const
	获取当前对象的句柄。更多...

额外继承的成员函数
静态 Public 成员函数继承自 foxit::pdf::actions::Action
static Action	Create (const foxit::pdf::PDFDoc &document, Type action_type)
	为指定的动作类型创建新动作。更多...

详细描述

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

参见: Action

成员枚举类型说明

◆ Flags

enum foxit::pdf::actions::SubmitFormAction::Flags

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

此枚举的值可以单独使用或组合使用。

枚举值
e_FlagExclude	位1。如果设置，提交表单动作中定义的字段名称应从提交中排除；如果未设置，则只有这些字段名称（包括其后代）将被提交。
e_FlagIncludeNoValueFields	位2。无论字段是否有值都提交字段。注解对于没有值的字段，只传输字段名称。
e_FlagExportFormat	位3。字段名称和值以HTML表单格式提交。注解仅在标志SubmitFormAction::e_FlagAsXFDF和 SubmitFormAction::e_FlagSubmitAsPDF未设置时有意义。如果此标志未设置，则表示以表单数据格式(FDF)提交。
e_FlagGetMethod	位4。字段名称和值使用HTTP GET请求提交。注解仅在设置标志SubmitFormAction::e_FlagExportFormat时有意义。如果此标志未设置，则表示使用POST请求提交。
e_FlagWithCoordinates	位5。鼠标坐标作为表单数据的一部分传输。
e_FlagAsXFDF	位6。字段名称和值以XFDF格式提交。
e_FlagIncludeAppendSaves	位7。提交的FDF文件包含FDF字典中差异条目包含的内容。注解仅在表单以表单数据格式提交时有意义。
e_FlagIncludeAnnotations	位8。提交的FDF文件包含底层PDF文档中的所有标记注释。注解仅在表单以表单数据格式提交时有意义。
e_FlagSubmitAsPDF	位9。文档以PDF格式提交。
e_FlagCanonicalFormat	位10。任何表示日期的提交字段值都转换为标准格式。
e_FlagExclNonUserAnnots	位11。只有那些"T"条目与当前用户名称匹配的标记注释才被提交。
e_FlagExclFKey	位12。提交的FDF排除"F"条目。
e_FlagEmbedForm	位14。提交的FDF的"F"条目是嵌入文件流。

构造及析构函数说明

◆ SubmitFormAction()

foxit::pdf::actions::SubmitFormAction::SubmitFormAction ( const Action & action )

explicit

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

参数

[in] action 父类对象。

成员函数说明

◆ GetFieldNames()

WStringArray foxit::pdf::actions::SubmitFormAction::GetFieldNames ( )

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

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

返回: 字段名称数组。

◆ GetFlags()

uint32 foxit::pdf::actions::SubmitFormAction::GetFlags ( )

获取用于提交的标志值。

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

◆ GetURL()

String foxit::pdf::actions::SubmitFormAction::GetURL ( )

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

返回: URI字符串。

◆ SetFieldNames()

void foxit::pdf::actions::SubmitFormAction::SetFieldNames ( const WStringArray & field_names )

设置字段名称数组。

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

参数

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

返回: 无。

◆ SetFlags()

void foxit::pdf::actions::SubmitFormAction::SetFlags ( uint32 flags )

设置用于提交的标志值。

参数

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

返回: 无。

◆ SetURL()

void foxit::pdf::actions::SubmitFormAction::SetURL ( const String & url )

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

参数

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

返回: 无。

Public 类型

Public 成员函数

额外继承的成员函数

详细描述

成员枚举类型说明

◆ Flags

构造及析构函数说明

◆ SubmitFormAction()

成员函数说明

◆ GetFieldNames()

◆ GetFlags()

◆ GetURL()

◆ SetFieldNames()

◆ SetFlags()

◆ SetURL()