类 foxit::addon::xfa::XFAWidget 继承关系图:

Public 类型
enum	HitTestArea { e_HitTestAreaUnknown = 0, e_HitTestAreaClient = 1, e_HitTestAreaTitleBar = 2, e_HitTestAreaHyperLink = 3 }
	XFA 控件命中测试区域的枚举。更多...

enum	PresenceProperty { e_PresenceUnknown = 0, e_PresenceVisible = 1, e_PresenceHidden = 2, e_PresenceInactive = 3, e_PresenceInvisible = 4 }
	XFA 控件存在属性的枚举。更多...

enum	WidgetEdgePosition { e_WidgetEdgePositionTop = 0, e_WidgetEdgePositionRight = 1, e_WidgetEdgePositionBottom = 2, e_WidgetEdgePositionLeft = 3 }
	XFA 控件边缘位置的枚举。更多...

enum	WidgetHAlignType { e_WidgethAlignTypeCenter = 128, e_WidgethAlignTypeJustify = 156, e_WidgethAlignTypeLeft = 252, e_WidgethAlignTypeRadix = 231, e_WidgethAlignTypeRight = 54 }
	XFA 控件文本水平对齐类型的枚举。更多...

enum	WidgetNameType { e_WidgetNameTypeField = 0, e_WidgetNameTypeCaption = 1, e_WidgetNameTypeFullName = 2 }
	XFA 控件名称类型的枚举。更多...

enum	WidgetType { e_WidgetTypeBarcode = 0, e_WidgetTypePushButton = 1, e_WidgetTypeCheckButton = 2, e_WidgetTypeArc = 3, e_WidgetTypeDateTimeEdit = 4, e_WidgetTypeNumericEdit = 5, e_WidgetTypeSignature = 6, e_WidgetTypeChoiceList = 7, e_WidgetTypeImageEdit = 8, e_WidgetTypeLine = 9, e_WidgetTypePasswordEdit = 10, e_WidgetTypeRadioButton = 11, e_WidgetTypeRectangle = 12, e_WidgetTypeTextEdit = 13, e_WidgetTypeUnknown = 14, e_WidgetTypeExclGroup = 15, e_WidgetTypeImage = 16 }
	XFA 控件类型的枚举。更多...

enum	WidgetVAlignType { e_WidgetvAlignTypeTop = 33, e_WidgetvAlignTypeBottom = 85, e_WidgetvAlignTypeMiddle = 161 }
	XFA 控件文本垂直对齐类型的枚举。更多...

Public 成员函数
	XFAWidget (const XFAWidget &other)
	构造函数，使用另一个 XFA 控件对象。更多...

	~XFAWidget ()
	析构函数。

foxit::common::Bitmap	GetBitmap ()
	获取当前 XFA 控件的位图。更多...

WString	GetDefaultValue ()
	获取默认值字符串。更多...

WidgetHAlignType	GetHAlign ()
	获取文本水平对齐方式。更多...

int	GetIndex () const
	获取 XFA 控件在相关 XFA 页面中的索引。更多...

WString	GetJavaScript ()
	获取当前 XFA 控件验证的 JavaScript。更多...

WString	GetName (WidgetNameType type)
	获取控件名称。更多...

addon::xfa::WidgetChoiceOptionArray	GetOptions () const
	获取选择列表或排斥组（仅用于单选按钮）的选项。更多...

PresenceProperty	GetPresence ()
	获取 XFA 控件的存在属性。更多...

RectF	GetRect ()
	获取 XFA 控件的矩形。更多...

foxit::pdf::Signature	GetSignature ()
	从当前 XFA 控件获取签名对象。更多...

WString	GetToolTip ()
	获取工具提示字符串。更多...

WidgetType	GetType ()
	获取 XFA 控件的类型。更多...

WidgetVAlignType	GetVAlign ()
	获取文本垂直对齐方式。更多...

WString	GetValue ()
	获取值字符串。更多...

XFAPage	GetXFAPage ()
	获取当前 XFA 控件所属的相关 XFA 页面。更多...

String	GetXMLContent ()
	获取当前 XFA 控件的 XML 内容。更多...

bool	HasEdge (WidgetEdgePosition edge_pos)
	检查指定位置的边框是否存在。更多...

bool	IsAllowRichText ()
	检查控件是否允许富文本格式。更多...

bool	IsChecked () const
	检查当前 XFA 控件是否已选中。更多...

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

bool	IsListBox ()
	检查控件是否为列表框。更多...

bool	IsReadOnly ()
	检查控件是否为只读。更多...

bool	IsRequired ()
	检查控件在通过提交表单操作导出时是否需要值。更多...

bool	IsSupportMultiline ()
	检查控件是否支持多行。更多...

bool	IsSupportMultiSelect ()
	检查控件是否支持多选。更多...

bool	OnChar (int input_char, uint32 flags)
	当输入字符代码时调用此函数。更多...

HitTestArea	OnHitTest (const PointF &point)
	调用此函数对指定点进行命中测试。更多...

bool	OnKeyDown (uint32 key_code, uint32 flags)
	当键盘按键按下时调用此函数。更多...

bool	OnKeyUp (uint32 key_code, uint32 flags)
	当键盘按键释放时调用此函数。更多...

bool	OnLButtonDoubleClick (const PointF &point, uint32 flags)
	当鼠标左键双击时调用此函数。更多...

bool	OnLButtonDown (const PointF &point, uint32 flags)
	当鼠标左键按下时调用此函数。更多...

bool	OnLButtonUp (const PointF &point, uint32 flags)
	当鼠标左键释放时调用此函数。更多...

bool	OnMouseEnter ()
	当鼠标进入当前 XFA 控件时调用此函数。更多...

bool	OnMouseExit ()
	当鼠标退出时调用此函数。更多...

bool	OnMouseMove (const PointF &point, uint32 flags)
	当鼠标移动时调用此函数。更多...

bool	OnRButtonDown (const PointF &point, uint32 flags)
	当鼠标右键按下时调用此函数。更多...

bool	OnRButtonUp (const PointF &point, uint32 flags)
	当鼠标右键释放时调用此函数。更多...

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

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

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

void	ResetData ()
	重置 XFA 控件数据。更多...

void	SetCheckState (bool is_checked)
	设置当前 XFA 控件的选中状态。更多...

void	SetDefaultValue (const wchar_t *value)
	设置默认值字符串。更多...

void	SetImage (const foxit::common::Image &image)
	为当前 XFA 控件设置图像。更多...

bool	SetOptions (const addon::xfa::WidgetChoiceOptionArray &option_array)
	设置选择列表或排斥组（仅用于单选按钮）的选项。更多...

void	SetValue (const wchar_t *value)
	设置值字符串。更多...

bool	ValidateValue (const wchar_t *value, WString &format)
	验证值是否符合当前 XFA 控件的格式。更多...

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

详细描述

类 XFAWidget 表示从 XFA 页面对象中检索的 XFA 控件。
要访问 XFA 控件的菜单，请使用 XFAWidget 对象构造一个 xfa::WidgetMenu 对象。

参见: WidgetMenu

成员枚举类型说明

◆ HitTestArea

enum foxit::addon::xfa::XFAWidget::HitTestArea

XFA 控件命中测试区域的枚举。

此枚举的值应单独使用。

枚举值
e_HitTestAreaUnknown	命中测试区域：未知。
e_HitTestAreaClient	命中测试区域：客户端。
e_HitTestAreaTitleBar	命中测试区域：标题栏。
e_HitTestAreaHyperLink	命中测试区域：超链接。

◆ PresenceProperty

enum foxit::addon::xfa::XFAWidget::PresenceProperty

XFA 控件存在属性的枚举。

此枚举的值应单独使用。
存在属性控制关联对象在处理的不同阶段的参与。

枚举值
e_PresenceUnknown	存在属性：未知。
e_PresenceVisible	存在属性：可见。参与交互、布局和渲染。
e_PresenceHidden	存在属性：隐藏。参与交互但不参与布局或渲染。
e_PresenceInactive	存在属性：非活动。不参与交互、布局或渲染。
e_PresenceInvisible	存在属性：不可见。参与交互和布局但不参与渲染。

◆ WidgetEdgePosition

enum foxit::addon::xfa::XFAWidget::WidgetEdgePosition

XFA 控件边缘位置的枚举。

此枚举的值应单独使用。

枚举值
e_WidgetEdgePositionTop	边缘位置：顶部。
e_WidgetEdgePositionRight	边缘位置：右侧。
e_WidgetEdgePositionBottom	边缘位置：底部。
e_WidgetEdgePositionLeft	边缘位置：左侧。

◆ WidgetHAlignType

enum foxit::addon::xfa::XFAWidget::WidgetHAlignType

XFA 控件文本水平对齐类型的枚举。

此枚举的值应单独使用。

枚举值
e_WidgethAlignTypeCenter	在可用区域内水平居中文本。
e_WidgethAlignTypeJustify	左对齐最后一行并分散对齐其余行。
e_WidgethAlignTypeLeft	分散对齐所有行以填充可用区域。将文本对齐到可用区域的左边缘。
e_WidgethAlignTypeRadix	对齐基数指示符。
e_WidgethAlignTypeRight	将文本对齐到可用区域的右边缘。

◆ WidgetNameType

enum foxit::addon::xfa::XFAWidget::WidgetNameType

XFA 控件名称类型的枚举。

此枚举的值应单独使用。

枚举值
e_WidgetNameTypeField	名称类型：字段名称。此类型的名称将从 XFA 控件的名称条目中检索，可能是空字符串。
e_WidgetNameTypeCaption	名称类型：标题名称。此类型的名称将从标题条目中检索。
e_WidgetNameTypeFullName	名称类型：全名。

◆ WidgetType

enum foxit::addon::xfa::XFAWidget::WidgetType

XFA 控件类型的枚举。

此枚举的值应单独使用。

枚举值
e_WidgetTypeBarcode	XFA 控件类型：条形码。
e_WidgetTypePushButton	XFA 控件类型：按钮。
e_WidgetTypeCheckButton	XFA 控件类型：复选框。
e_WidgetTypeArc	XFA 控件类型：弧形。
e_WidgetTypeDateTimeEdit	XFA 控件类型：日期时间编辑。
e_WidgetTypeNumericEdit	XFA 控件类型：数字编辑。
e_WidgetTypeSignature	XFA 控件类型：签名。
e_WidgetTypeChoiceList	XFA 控件类型：选择列表。
e_WidgetTypeImageEdit	XFA 控件类型：图像编辑。
e_WidgetTypeLine	XFA 控件类型：线条。
e_WidgetTypePasswordEdit	XFA 控件类型：密码编辑。
e_WidgetTypeRadioButton	XFA 控件类型：单选按钮。
e_WidgetTypeRectangle	XFA 控件类型：矩形。
e_WidgetTypeTextEdit	XFA 控件类型：文本编辑。
e_WidgetTypeUnknown	XFA 控件类型：未知。
e_WidgetTypeExclGroup	XFA 控件类型：单选按钮的排斥组。
e_WidgetTypeImage	XFA 控件类型：图像。

◆ WidgetVAlignType

enum foxit::addon::xfa::XFAWidget::WidgetVAlignType

XFA 控件文本垂直对齐类型的枚举。

此枚举的值应单独使用。

枚举值
e_WidgetvAlignTypeTop	将文本对齐到可用区域的顶部。
e_WidgetvAlignTypeBottom	将文本对齐到可用区域的底部。
e_WidgetvAlignTypeMiddle	将文本对齐，使其在可用区域的顶部和底部之间居中。

构造及析构函数说明

◆ XFAWidget()

foxit::addon::xfa::XFAWidget::XFAWidget ( const XFAWidget & other )

构造函数，使用另一个 XFA 控件对象。

参数

[in] other 另一个 XFA 控件对象。

成员函数说明

◆ GetBitmap()

foxit::common::Bitmap foxit::addon::xfa::XFAWidget::GetBitmap ( )

获取当前 XFA 控件的位图。

仅适用于当前 XFA 控件类型为 XFAWidget::e_WidgetTypeImageEdit 或 XFAWidget::e_WidgetTypeImage 的情况。对于不适用的类型，此函数将抛出异常 foxit::e_ErrUnsupported。

返回: 当前 XFA 控件的位图。

◆ GetDefaultValue()

WString foxit::addon::xfa::XFAWidget::GetDefaultValue ( )

获取默认值字符串。

返回: 默认值字符串。

◆ GetHAlign()

WidgetHAlignType foxit::addon::xfa::XFAWidget::GetHAlign ( )

获取文本水平对齐方式。

返回: 文本水平对齐方式。请参考从 XFAWidget::e_WidgethAlignTypeLeft 开始的值，这将是这些值中的一个。

◆ GetIndex()

int foxit::addon::xfa::XFAWidget::GetIndex ( ) const

获取 XFA 控件在相关 XFA 页面中的索引。

返回: XFA 控件在相关 XFA 页面中的索引。

◆ GetJavaScript()

WString foxit::addon::xfa::XFAWidget::GetJavaScript ( )

获取当前 XFA 控件验证的 JavaScript。

返回: 当前 XFA 控件验证的 JavaScript。

◆ GetName()

WString foxit::addon::xfa::XFAWidget::GetName ( WidgetNameType type )

获取控件名称。

参数

[in] type 名称类型。请参考从 XFAWidget::e_WidgetNameTypeField 开始的值，这应该是这些值之一。

返回: 控件名称字符串。

◆ GetOptions()

addon::xfa::WidgetChoiceOptionArray foxit::addon::xfa::XFAWidget::GetOptions ( ) const

获取选择列表或排斥组（仅用于单选按钮）的选项。

适用于选择列表和排斥组（仅用于单选按钮）。对于不适用的类型，此函数将返回空数组。

返回: 选择选项数组。

◆ GetPresence()

PresenceProperty foxit::addon::xfa::XFAWidget::GetPresence ( )

获取 XFA 控件的存在属性。

存在属性控制关联对象在不同处理阶段的参与。

返回: XFA 控件的存在属性。

◆ GetRect()

RectF foxit::addon::xfa::XFAWidget::GetRect ( )

获取 XFA 控件的矩形。

控件矩形在 XFA 坐标系中定义。XFA 坐标系定义为原点在左上角， x 轴指向右，y 轴指向下。

返回: XFA 控件的矩形。

◆ GetSignature()

foxit::pdf::Signature foxit::addon::xfa::XFAWidget::GetSignature ( )

从当前 XFA 控件获取签名对象。

仅适用于当前 XFA 控件表示签名的情况。对于不适用的类型，此函数将抛出异常 foxit::e_ErrUnsupported。

返回: 签名对象。

◆ GetToolTip()

WString foxit::addon::xfa::XFAWidget::GetToolTip ( )

获取工具提示字符串。

返回: 工具提示字符串。

◆ GetType()

WidgetType foxit::addon::xfa::XFAWidget::GetType ( )

获取 XFA 控件的类型。

返回: XFA 控件类型。请参考从 XFAWidget::e_WidgetTypeBarcode 开始的值，这将是这些值中的一个。

◆ GetVAlign()

WidgetVAlignType foxit::addon::xfa::XFAWidget::GetVAlign ( )

获取文本垂直对齐方式。

返回: 文本垂直对齐方式。请参考从 XFAWidget::e_WidgetvAlignTypeTop 开始的值，这将是这些值中的一个。

◆ GetValue()

WString foxit::addon::xfa::XFAWidget::GetValue ( )

获取值字符串。

返回: 值字符串。

◆ GetXFAPage()

XFAPage foxit::addon::xfa::XFAWidget::GetXFAPage ( )

获取当前 XFA 控件所属的相关 XFA 页面。

返回: XFA 页面对象。

◆ GetXMLContent()

String foxit::addon::xfa::XFAWidget::GetXMLContent ( )

获取当前 XFA 控件的 XML 内容。

返回: 当前 XFA 控件的 XML 内容。

◆ HasEdge()

bool foxit::addon::xfa::XFAWidget::HasEdge ( WidgetEdgePosition edge_pos )

检查指定位置的边框是否存在。

参数

[in] edge_pos 边框位置，用于指定将检查哪个边框。请参考从 XFAWidget::e_WidgetEdgePositionTop 开始的值，这应该是这些值中的一个。

返回: true 表示指定位置的边框存在，false 表示不存在此类边框。

◆ IsAllowRichText()

bool foxit::addon::xfa::XFAWidget::IsAllowRichText ( )

检查控件是否允许富文本格式。

只有类型为 XFAWidget::e_WidgetTypeTextEdit 的文本编辑控件支持富文本。

返回: true 表示控件允许富文本格式，false 表示不允许。

◆ IsChecked()

bool foxit::addon::xfa::XFAWidget::IsChecked ( ) const

检查当前 XFA 控件是否已选中。

适用于复选框或单选按钮作为相关 XFA 控件。对于不适用的类型，此函数将返回 false。

返回: true 表示已选中，false 表示未选中或失败。

◆ IsEmpty()

bool foxit::addon::xfa::XFAWidget::IsEmpty ( ) const

检查当前对象是否为空。

当前对象为空时，表示当前对象无用。

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

◆ IsListBox()

bool foxit::addon::xfa::XFAWidget::IsListBox ( )

检查控件是否为列表框。

返回: true 表示控件是列表框，false 表示不是。

◆ IsReadOnly()

bool foxit::addon::xfa::XFAWidget::IsReadOnly ( )

检查控件是否为只读。

返回: true 表示字段的值不能更改，false 表示可以更改。

◆ IsRequired()

bool foxit::addon::xfa::XFAWidget::IsRequired ( )

检查控件在通过提交表单操作导出时是否需要值。

返回: true 表示字段在通过提交表单操作导出时必须有值， false 表示不需要。

◆ IsSupportMultiline()

bool foxit::addon::xfa::XFAWidget::IsSupportMultiline ( )

检查控件是否支持多行。

只有类型为 XFAWidget::e_WidgetTypeTextEdit 的文本编辑控件支持多行。

返回: true 表示控件支持多行，false 表示不支持。

◆ IsSupportMultiSelect()

bool foxit::addon::xfa::XFAWidget::IsSupportMultiSelect ( )

检查控件是否支持多选。

只有列表框控件支持多选，其类型为 XFAWidget::e_WidgetTypeChoiceList 且函数 xfa::XFAWidget::IsListBox 的返回值为 true。

返回: true 表示控件支持多选，false 表示不支持。

◆ OnChar()

bool foxit::addon::xfa::XFAWidget::OnChar	(	int	input_char,
		uint32	flags
	)

当输入字符代码时调用此函数。

参数

[in]	input_char	字符代码，使用 UTF16-LE 编码。
[in]	flags	事件标志。请参考从 pdf::interform::Filler::e_EventFlagShiftKey 开始的值，这应该是这些值中的一个或组合。

返回: true 表示成功，false 表示失败。

◆ OnHitTest()

HitTestArea foxit::addon::xfa::XFAWidget::OnHitTest ( const PointF & point )

调用此函数对指定点进行命中测试。

参数

[in] point 要测试的点。

返回: 命中测试区域。请参考从 XFAWidget::e_HitTestAreaUnknown 开始的值，这将是这些值中的一个。

◆ OnKeyDown()

bool foxit::addon::xfa::XFAWidget::OnKeyDown	(	uint32	key_code,
		uint32	flags
	)

当键盘按键按下时调用此函数。

参数

[in]	key_code	键码。请参考从 pdf::interform::Filler::e_VkeyUnknown 开始的值，这应该是这些值中的一个。
[in]	flags	事件标志。请参考从 pdf::interform::Filler::e_EventFlagShiftKey 开始的值，这应该是这些值中的一个或组合。

返回: true 表示成功，false 表示失败。

◆ OnKeyUp()

bool foxit::addon::xfa::XFAWidget::OnKeyUp	(	uint32	key_code,
		uint32	flags
	)

当键盘按键释放时调用此函数。

参数

[in]	key_code	键码。请参考从 pdf::interform::Filler::e_VkeyUnknown 开始的值，这应该是这些值中的一个。
[in]	flags	事件标志。请参考从 pdf::interform::Filler::e_EventFlagShiftKey 开始的值，这应该是这些值中的一个或组合。

返回: true 表示成功，false 表示失败。

◆ OnLButtonDoubleClick()

bool foxit::addon::xfa::XFAWidget::OnLButtonDoubleClick	(	const PointF &	point,
		uint32	flags
	)

当鼠标左键双击时调用此函数。

参数

[in]	point	鼠标左键在 XFA 页面中双击的点，使用 PDF 坐标系统。
[in]	flags	事件标志。请参考从 pdf::interform::Filler::e_EventFlagShiftKey 开始的值，这应该是这些值中的一个或组合。

返回: true 表示成功，false 表示失败。

◆ OnLButtonDown()

bool foxit::addon::xfa::XFAWidget::OnLButtonDown	(	const PointF &	point,
		uint32	flags
	)

当鼠标左键按下时调用此函数。

参数

[in]	point	鼠标左键在 XFA 页面中按下的点，使用 PDF 坐标系统。
[in]	flags	事件标志。请参考从 pdf::interform::Filler::e_EventFlagShiftKey 开始的值，这应该是这些值中的一个或组合。

返回: true 表示成功，false 表示失败。

◆ OnLButtonUp()

bool foxit::addon::xfa::XFAWidget::OnLButtonUp	(	const PointF &	point,
		uint32	flags
	)

当鼠标左键释放时调用此函数。

参数

[in]	point	鼠标左键在 XFA 页面中释放的点，使用 PDF 坐标系统。
[in]	flags	事件标志。请参考从 pdf::interform::Filler::e_EventFlagShiftKey 开始的值，这应该是这些值中的一个或组合。

返回: true 表示成功，false 表示失败。

◆ OnMouseEnter()

bool foxit::addon::xfa::XFAWidget::OnMouseEnter ( )

当鼠标进入当前 XFA 控件时调用此函数。

返回: true 表示成功，false 表示失败。

◆ OnMouseExit()

bool foxit::addon::xfa::XFAWidget::OnMouseExit ( )

当鼠标退出时调用此函数。

返回: true 表示成功，false 表示失败。

◆ OnMouseMove()

bool foxit::addon::xfa::XFAWidget::OnMouseMove	(	const PointF &	point,
		uint32	flags
	)

当鼠标移动时调用此函数。

参数

[in]	point	鼠标在 XFA 页面中移动的点，使用 PDF 坐标系统。
[in]	flags	事件标志。请参考从 pdf::interform::Filler::e_EventFlagShiftKey 开始的值，这应该是这些值中的一个或组合。

返回: true 表示成功，false 表示失败。

◆ OnRButtonDown()

bool foxit::addon::xfa::XFAWidget::OnRButtonDown	(	const PointF &	point,
		uint32	flags
	)

当鼠标右键按下时调用此函数。

参数

[in]	point	鼠标右键在 XFA 页面中按下的点，使用 PDF 坐标系统。
[in]	flags	事件标志。请参考从 pdf::interform::Filler::e_EventFlagShiftKey 开始的值，这应该是这些值中的一个或组合。

返回: true 表示成功，false 表示失败。

◆ OnRButtonUp()

bool foxit::addon::xfa::XFAWidget::OnRButtonUp	(	const PointF &	point,
		uint32	flags
	)

当鼠标右键释放时调用此函数。

参数

[in]	point	鼠标右键在 XFA 页面中释放的点，使用 PDF 坐标系统。
[in]	flags	事件标志。请参考从 pdf::interform::Filler::e_EventFlagShiftKey 开始的值，这应该是这些值中的一个或组合。

返回: true 表示成功，false 表示失败。

◆ operator !=()

bool foxit::addon::xfa::XFAWidget::operator != ( const XFAWidget & other ) const

不相等操作符。

参数

[in] other 另一个 XFA 控件对象。此函数将检查当前对象是否与此对象不相等。

返回: true 表示不相等，false 表示相等。

◆ operator=()

XFAWidget& foxit::addon::xfa::XFAWidget::operator= ( const XFAWidget & other )

赋值操作符。

参数

[in] other 另一个 XFA 控件对象，其值将被赋给当前对象。

返回: 当前对象本身的引用。

◆ operator==()

bool foxit::addon::xfa::XFAWidget::operator== ( const XFAWidget & other ) const

相等操作符。

参数

[in] other 另一个 XFA 控件对象。此函数将检查当前对象是否与此对象相等。

返回: true 表示相等，false 表示不相等。

◆ ResetData()

void foxit::addon::xfa::XFAWidget::ResetData ( )

重置 XFA 控件数据。

返回: 无。

◆ SetCheckState()

void foxit::addon::xfa::XFAWidget::SetCheckState ( bool is_checked )

设置当前 XFA 控件的选中状态。

适用于复选框或单选按钮作为相关 XFA 控件。对于不适用的类型，此函数将抛出异常 foxit::e_ErrUnsupported。

参数

[in] is_checked true 表示当前 XFA 控件将被选中， false 表示不会被选中。

返回: 无。

◆ SetDefaultValue()

void foxit::addon::xfa::XFAWidget::SetDefaultValue ( const wchar_t * value )

设置默认值字符串。

仅对类型为 XFAWidget::e_WidgetTypeTextEdit、XFAWidget::e_WidgetTypeNumericEdit、 XFAWidget::e_WidgetTypePasswordEdit 或 XFAWidget::e_WidgetTypeDateTimeEdit 的 XFA 控件有用。

参数

[in] value 要设置的默认值字符串。可以是空字符串。

返回: 无。

◆ SetImage()

void foxit::addon::xfa::XFAWidget::SetImage ( const foxit::common::Image & image )

为当前 XFA 控件设置图像。

仅适用于当前 XFA 控件类型为 XFAWidget::e_WidgetTypeImageEdit 的情况。对于不适用的类型，此函数将抛出异常 foxit::e_ErrUnsupported。

参数

[in]

image

将设置到当前 XFA 控件的图像。目前，此函数仅支持以下图像类型：

如果尝试设置其他不支持的图像类型，将抛出异常 foxit::e_ErrUnsupported。

返回: 无。

◆ SetOptions()

bool foxit::addon::xfa::XFAWidget::SetOptions ( const addon::xfa::WidgetChoiceOptionArray & option_array )

设置选择列表或排斥组（仅用于单选按钮）的选项。

适用于选择列表和排斥组（仅用于单选按钮）。对于不适用的类型，此函数将返回 false。

参数

[in] option_array 要设置的选择选项数组。

返回: true 表示成功，false 表示失败。

◆ SetValue()

void foxit::addon::xfa::XFAWidget::SetValue ( const wchar_t * value )

设置值字符串。

仅对类型为 XFAWidget::e_WidgetTypeTextEdit、XFAWidget::e_WidgetTypeNumericEdit、 XFAWidget::e_WidgetTypePasswordEdit 或 XFAWidget::e_WidgetTypeDateTimeEdit 的 XFA 控件有用。

参数

[in] value 要设置的值字符串。可以是空字符串。

返回: 无。

◆ ValidateValue()

bool foxit::addon::xfa::XFAWidget::ValidateValue	(	const wchar_t *	value,
		WString &	format
	)

验证值是否符合当前 XFA 控件的格式。

此函数可以在函数 XFAWidget::SetValue 之前调用，以检查值是否符合当前 XFA 控件的格式。

参数

[in]	value	要验证的字符串值。
[out]	format	接收当前 XFA 控件格式的字符串值。如果当前 XFA 控件没有格式，它将是空字符串。

返回: true 表示值符合当前 XFA 控件的格式，false 表示不符合。

Public 类型

Public 成员函数

详细描述

成员枚举类型说明

◆ HitTestArea

◆ PresenceProperty

◆ WidgetEdgePosition

◆ WidgetHAlignType

◆ WidgetNameType

◆ WidgetType

◆ WidgetVAlignType

构造及析构函数说明

◆ XFAWidget()

成员函数说明

◆ GetBitmap()

◆ GetDefaultValue()

◆ GetHAlign()

◆ GetIndex()

◆ GetJavaScript()

◆ GetName()

◆ GetOptions()

◆ GetPresence()

◆ GetRect()

◆ GetSignature()

◆ GetToolTip()

◆ GetType()

◆ GetVAlign()

◆ GetValue()

◆ GetXFAPage()

◆ GetXMLContent()

◆ HasEdge()

◆ IsAllowRichText()

◆ IsChecked()

◆ IsEmpty()

◆ IsListBox()

◆ IsReadOnly()

◆ IsRequired()

◆ IsSupportMultiline()

◆ IsSupportMultiSelect()

◆ OnChar()

◆ OnHitTest()

◆ OnKeyDown()

◆ OnKeyUp()

◆ OnLButtonDoubleClick()

◆ OnLButtonDown()

◆ OnLButtonUp()

◆ OnMouseEnter()

◆ OnMouseExit()

◆ OnMouseMove()

◆ OnRButtonDown()

◆ OnRButtonUp()

◆ operator !=()

◆ operator=()

◆ operator==()

◆ ResetData()

◆ SetCheckState()

◆ SetDefaultValue()

◆ SetImage()

◆ SetOptions()

◆ SetValue()

◆ ValidateValue()