Public 成员函数
def	GetBitmap ()
	获取当前 XFA 控件的位图。更多...

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

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

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

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

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

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

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

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

def	GetSignature ()
	从当前 XFA 控件获取签名对象。更多...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

def	OnLButtonDoubleClick (point, flags)
	当鼠标左键双击时调用此函数。更多...

def	OnLButtonDown (point, flags)
	当鼠标左键按下时调用此函数。更多...

def	OnLButtonUp (point, flags)
	当鼠标左键释放时调用此函数。更多...

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

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

def	OnMouseMove (point, flags)
	当鼠标移动时调用此函数。更多...

def	OnRButtonDown (point, flags)
	当鼠标右键按下时调用此函数。更多...

def	OnRButtonUp (point, flags)
	当鼠标右键释放时调用此函数。更多...

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

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

def	SetDefaultValue (value)
	设置默认值字符串。更多...

def	SetImage (image)
	为当前 XFA 控件设置图像。更多...

def	SetOptions (option_array)
	设置选择列表或排斥组（仅用于单选按钮）的选项。更多...

def	SetValue (value)
	设置值字符串。更多...

详细描述

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

参见: WidgetMenu

成员函数说明

◆ GetBitmap()

def fsdk.XFAWidget.GetBitmap ( )

获取当前 XFA 控件的位图。

仅适用于当前 XFA 控件类型为 fsdk.XFAWidgetE_WidgetTypeImageEdit 或 fsdk.XFAWidgetE_WidgetTypeImage 的情况。对于不适用的类型，此函数将抛出异常 fsdk.E_ErrUnsupported 。

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

◆ GetDefaultValue()

def fsdk.XFAWidget.GetDefaultValue ( )

获取默认值字符串。

返回: 默认值字符串。

◆ GetHAlign()

def fsdk.XFAWidget.GetHAlign ( )

获取文本水平对齐方式。

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

◆ GetIndex()

def fsdk.XFAWidget.GetIndex ( )

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

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

◆ GetJavaScript()

def fsdk.XFAWidget.GetJavaScript ( )

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

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

◆ GetName()

def fsdk.XFAWidget.GetName ( type )

获取控件名称。

参数

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

返回: 控件名称字符串。

◆ GetOptions()

def fsdk.XFAWidget.GetOptions ( )

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

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

返回: 选择选项数组。

◆ GetPresence()

def fsdk.XFAWidget.GetPresence ( )

获取 XFA 控件的存在属性。

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

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

◆ GetRect()

def fsdk.XFAWidget.GetRect ( )

获取 XFA 控件的矩形。

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

返回: XFA 控件的矩形。

◆ GetSignature()

def fsdk.XFAWidget.GetSignature ( )

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

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

返回: 签名对象。

◆ GetToolTip()

def fsdk.XFAWidget.GetToolTip ( )

获取工具提示字符串。

返回: 工具提示字符串。

◆ GetType()

def fsdk.XFAWidget.GetType ( )

获取 XFA 控件的类型。

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

◆ GetVAlign()

def fsdk.XFAWidget.GetVAlign ( )

获取文本垂直对齐方式。

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

◆ GetValue()

def fsdk.XFAWidget.GetValue ( )

获取值字符串。

返回: 值字符串。

◆ GetXFAPage()

def fsdk.XFAWidget.GetXFAPage ( )

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

返回: XFA 页面对象。

◆ GetXMLContent()

def fsdk.XFAWidget.GetXMLContent ( )

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

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

◆ HasEdge()

def fsdk.XFAWidget.HasEdge ( edge_pos )

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

参数

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

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

◆ IsAllowRichText()

def fsdk.XFAWidget.IsAllowRichText ( )

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

只有类型为 fsdk.XFAWidgetE_WidgetTypeTextEdit 的文本编辑控件支持富文本。

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

◆ IsChecked()

def fsdk.XFAWidget.IsChecked ( )

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

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

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

◆ IsEmpty()

def fsdk.XFAWidget.IsEmpty ( )

检查当前对象是否为空。

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

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

◆ IsListBox()

def fsdk.XFAWidget.IsListBox ( )

检查控件是否为列表框。

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

◆ IsReadOnly()

def fsdk.XFAWidget.IsReadOnly ( )

检查控件是否为只读。

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

◆ IsRequired()

def fsdk.XFAWidget.IsRequired ( )

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

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

◆ IsSupportMultiline()

def fsdk.XFAWidget.IsSupportMultiline ( )

检查控件是否支持多行。

只有类型为 fsdk.XFAWidgetE_WidgetTypeTextEdit 的文本编辑控件支持多行。

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

◆ IsSupportMultiSelect()

def fsdk.XFAWidget.IsSupportMultiSelect ( )

检查控件是否支持多选。

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

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

◆ OnChar()

def fsdk.XFAWidget.OnChar	(	input_char,
		flags
	)

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

参数

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

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

◆ OnHitTest()

def fsdk.XFAWidget.OnHitTest ( point )

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

参数

[in] point 要测试的点。

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

◆ OnKeyDown()

def fsdk.XFAWidget.OnKeyDown	(	key_code,
		flags
	)

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

参数

[in]	key_code	键码。请参考从 fsdk.FillerE_VkeyUnknown 开始的值，这应该是这些值中的一个。
[in]	flags	事件标志。请参考从 fsdk.FillerE_EventFlagShiftKey 开始的值，这应该是这些值中的一个或组合。

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

◆ OnKeyUp()

def fsdk.XFAWidget.OnKeyUp	(	key_code,
		flags
	)

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

参数

[in]	key_code	键码。请参考从 fsdk.FillerE_VkeyUnknown 开始的值，这应该是这些值中的一个。
[in]	flags	事件标志。请参考从 fsdk.FillerE_EventFlagShiftKey 开始的值，这应该是这些值中的一个或组合。

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

◆ OnLButtonDoubleClick()

def fsdk.XFAWidget.OnLButtonDoubleClick	(	point,
		flags
	)

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

参数

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

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

◆ OnLButtonDown()

def fsdk.XFAWidget.OnLButtonDown	(	point,
		flags
	)

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

参数

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

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

◆ OnLButtonUp()

def fsdk.XFAWidget.OnLButtonUp	(	point,
		flags
	)

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

参数

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

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

◆ OnMouseEnter()

def fsdk.XFAWidget.OnMouseEnter ( )

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

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

◆ OnMouseExit()

def fsdk.XFAWidget.OnMouseExit ( )

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

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

◆ OnMouseMove()

def fsdk.XFAWidget.OnMouseMove	(	point,
		flags
	)

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

参数

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

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

◆ OnRButtonDown()

def fsdk.XFAWidget.OnRButtonDown	(	point,
		flags
	)

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

参数

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

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

◆ OnRButtonUp()

def fsdk.XFAWidget.OnRButtonUp	(	point,
		flags
	)

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

参数

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

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

◆ ResetData()

def fsdk.XFAWidget.ResetData ( )

重置 XFA 控件数据。

返回: 无。

◆ SetCheckState()

def fsdk.XFAWidget.SetCheckState ( is_checked )

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

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

参数

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

返回: 无。

◆ SetDefaultValue()

def fsdk.XFAWidget.SetDefaultValue ( value )

设置默认值字符串。

仅对类型为 fsdk.XFAWidgetE_WidgetTypeTextEdit 、 fsdk.XFAWidgetE_WidgetTypeNumericEdit 、 fsdk.XFAWidgetE_WidgetTypePasswordEdit 或 fsdk.XFAWidgetE_WidgetTypeDateTimeEdit 的 XFA 控件有用。

参数

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

返回: 无。

◆ SetImage()

def fsdk.XFAWidget.SetImage ( image )

为当前 XFA 控件设置图像。

仅适用于当前 XFA 控件类型为 fsdk.XFAWidgetE_WidgetTypeImageEdit 的情况。对于不适用的类型，此函数将抛出异常 fsdk.E_ErrUnsupported 。

参数

[in]

image

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

如果尝试设置其他不支持的图像类型，将抛出异常 fsdk.E_ErrUnsupported 。

返回: 无。

◆ SetOptions()

def fsdk.XFAWidget.SetOptions ( option_array )

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

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

参数

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

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

◆ SetValue()

def fsdk.XFAWidget.SetValue ( value )

设置值字符串。

仅对类型为 fsdk.XFAWidgetE_WidgetTypeTextEdit 、 fsdk.XFAWidgetE_WidgetTypeNumericEdit 、 fsdk.XFAWidgetE_WidgetTypePasswordEdit 或 fsdk.XFAWidgetE_WidgetTypeDateTimeEdit 的 XFA 控件有用。

参数

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

返回: 无。

Public 成员函数

详细描述

成员函数说明

◆ 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()

◆ ResetData()

◆ SetCheckState()

◆ SetDefaultValue()

◆ SetImage()

◆ SetOptions()

◆ SetValue()