Foxit PDF SDK

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

## Public 成员函数
def | XFAWidget (other)
| 构造函数，使用另一个 XFA 控件对象。 更多...
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)
| 设置值字符串。 更多...
def | ValidateValue (value, format)
| 验证值是否符合当前 XFA 控件的格式。 更多...

## 静态 Public 属性
| e_HitTestAreaClient = _fsdk.XFAWidget_e_HitTestAreaClient
| 命中测试区域：客户端。
| e_HitTestAreaHyperLink = _fsdk.XFAWidget_e_HitTestAreaHyperLink
| 命中测试区域：超链接。
| e_HitTestAreaTitleBar = _fsdk.XFAWidget_e_HitTestAreaTitleBar
| 命中测试区域：标题栏。
| e_HitTestAreaUnknown = _fsdk.XFAWidget_e_HitTestAreaUnknown
| 命中测试区域：未知。
| e_PresenceHidden = _fsdk.XFAWidget_e_PresenceHidden
| 存在属性：隐藏。参与交互但不参与布局或渲染。
| e_PresenceInactive = _fsdk.XFAWidget_e_PresenceInactive
| 存在属性：非活动。不参与交互、布局或渲染。
| e_PresenceInvisible = _fsdk.XFAWidget_e_PresenceInvisible
| 存在属性：不可见。参与交互和布局但不参与渲染。
| e_PresenceUnknown = _fsdk.XFAWidget_e_PresenceUnknown
| 存在属性：未知。
| e_PresenceVisible = _fsdk.XFAWidget_e_PresenceVisible
| 存在属性：可见。参与交互、布局和渲染。
| e_WidgetEdgePositionBottom = _fsdk.XFAWidget_e_WidgetEdgePositionBottom
| 边缘位置：底部。
| e_WidgetEdgePositionLeft = _fsdk.XFAWidget_e_WidgetEdgePositionLeft
| 边缘位置：左侧。
| e_WidgetEdgePositionRight = _fsdk.XFAWidget_e_WidgetEdgePositionRight
| 边缘位置：右侧。
| e_WidgetEdgePositionTop = _fsdk.XFAWidget_e_WidgetEdgePositionTop
| 边缘位置：顶部。
| e_WidgethAlignTypeCenter = _fsdk.XFAWidget_e_WidgethAlignTypeCenter
| 在可用区域内水平居中文本。
| e_WidgethAlignTypeJustify = _fsdk.XFAWidget_e_WidgethAlignTypeJustify
| 左对齐最后一行并分散对齐其余行。
| e_WidgethAlignTypeLeft = _fsdk.XFAWidget_e_WidgethAlignTypeLeft
| 分散对齐所有行以填充可用区域。 更多...
| e_WidgethAlignTypeRadix = _fsdk.XFAWidget_e_WidgethAlignTypeRadix
| 对齐基数指示符。
| e_WidgethAlignTypeRight = _fsdk.XFAWidget_e_WidgethAlignTypeRight
| 将文本对齐到可用区域的右边缘。
| e_WidgetNameTypeCaption = _fsdk.XFAWidget_e_WidgetNameTypeCaption
| 名称类型：标题名称。此类型的名称将从标题条目中检索。
| e_WidgetNameTypeField = _fsdk.XFAWidget_e_WidgetNameTypeField
| 名称类型：字段名称。此类型的名称将从 XFA 控件的名称条目中检索，可能是空字符串。
| e_WidgetNameTypeFullName = _fsdk.XFAWidget_e_WidgetNameTypeFullName
| 名称类型：全名。
| e_WidgetTypeArc = _fsdk.XFAWidget_e_WidgetTypeArc
| XFA 控件类型：弧形。
| e_WidgetTypeBarcode = _fsdk.XFAWidget_e_WidgetTypeBarcode
| XFA 控件类型：条形码。
| e_WidgetTypeCheckButton = _fsdk.XFAWidget_e_WidgetTypeCheckButton
| XFA 控件类型：复选框。
| e_WidgetTypeChoiceList = _fsdk.XFAWidget_e_WidgetTypeChoiceList
| XFA 控件类型：选择列表。
| e_WidgetTypeDateTimeEdit = _fsdk.XFAWidget_e_WidgetTypeDateTimeEdit
| XFA 控件类型：日期时间编辑。
| e_WidgetTypeExclGroup = _fsdk.XFAWidget_e_WidgetTypeExclGroup
| XFA 控件类型：单选按钮的排斥组。
| e_WidgetTypeImage = _fsdk.XFAWidget_e_WidgetTypeImage
| XFA 控件类型：图像。
| e_WidgetTypeImageEdit = _fsdk.XFAWidget_e_WidgetTypeImageEdit
| XFA 控件类型：图像编辑。
| e_WidgetTypeLine = _fsdk.XFAWidget_e_WidgetTypeLine
| XFA 控件类型：线条。
| e_WidgetTypeNumericEdit = _fsdk.XFAWidget_e_WidgetTypeNumericEdit
| XFA 控件类型：数字编辑。
| e_WidgetTypePasswordEdit = _fsdk.XFAWidget_e_WidgetTypePasswordEdit
| XFA 控件类型：密码编辑。
| e_WidgetTypePushButton = _fsdk.XFAWidget_e_WidgetTypePushButton
| XFA 控件类型：按钮。
| e_WidgetTypeRadioButton = _fsdk.XFAWidget_e_WidgetTypeRadioButton
| XFA 控件类型：单选按钮。
| e_WidgetTypeRectangle = _fsdk.XFAWidget_e_WidgetTypeRectangle
| XFA 控件类型：矩形。
| e_WidgetTypeSignature = _fsdk.XFAWidget_e_WidgetTypeSignature
| XFA 控件类型：签名。
| e_WidgetTypeTextEdit = _fsdk.XFAWidget_e_WidgetTypeTextEdit
| XFA 控件类型：文本编辑。
| e_WidgetTypeUnknown = _fsdk.XFAWidget_e_WidgetTypeUnknown
| XFA 控件类型：未知。
| e_WidgetvAlignTypeBottom = _fsdk.XFAWidget_e_WidgetvAlignTypeBottom
| 将文本对齐到可用区域的底部。
| e_WidgetvAlignTypeMiddle = _fsdk.XFAWidget_e_WidgetvAlignTypeMiddle
| 将文本对齐，使其在可用区域的顶部和底部之间居中。
| e_WidgetvAlignTypeTop = _fsdk.XFAWidget_e_WidgetvAlignTypeTop
| 将文本对齐到可用区域的顶部。

## 详细描述

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

参见
  WidgetMenu

## 构造及析构函数说明

## ◆ XFAWidget()

def FoxitPDFSDKPython2.XFAWidget.XFAWidget | ( |  | other | ) |

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

参数

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

## 成员函数说明

## ◆ GetBitmap()

def FoxitPDFSDKPython2.XFAWidget.GetBitmap | ( |  | ) |

获取当前 XFA 控件的位图。

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

返回
  当前 XFA 控件的位图。

## ◆ GetDefaultValue()

def FoxitPDFSDKPython2.XFAWidget.GetDefaultValue | ( |  | ) |

获取默认值字符串。

返回
  默认值字符串。

## ◆ GetHAlign()

def FoxitPDFSDKPython2.XFAWidget.GetHAlign | ( |  | ) |

获取文本水平对齐方式。

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

## ◆ GetIndex()

def FoxitPDFSDKPython2.XFAWidget.GetIndex | ( |  | ) |

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

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

## ◆ GetJavaScript()

def FoxitPDFSDKPython2.XFAWidget.GetJavaScript | ( |  | ) |

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

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

## ◆ GetName()

def FoxitPDFSDKPython2.XFAWidget.GetName | ( |  | type | ) |

获取控件名称。

参数

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

返回
  控件名称字符串。

## ◆ GetOptions()

def FoxitPDFSDKPython2.XFAWidget.GetOptions | ( |  | ) |

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

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

返回
  选择选项数组。

## ◆ GetPresence()

def FoxitPDFSDKPython2.XFAWidget.GetPresence | ( |  | ) |

获取 XFA 控件的存在属性。

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

返回
  XFA 控件的存在属性。

## ◆ GetRect()

def FoxitPDFSDKPython2.XFAWidget.GetRect | ( |  | ) |

获取 XFA 控件的矩形。

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

返回
  XFA 控件的矩形。

## ◆ GetSignature()

def FoxitPDFSDKPython2.XFAWidget.GetSignature | ( |  | ) |

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

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

返回
  签名对象。

## ◆ GetToolTip()

def FoxitPDFSDKPython2.XFAWidget.GetToolTip | ( |  | ) |

获取工具提示字符串。

返回
  工具提示字符串。

## ◆ GetType()

def FoxitPDFSDKPython2.XFAWidget.GetType | ( |  | ) |

获取 XFA 控件的类型。

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

## ◆ GetVAlign()

def FoxitPDFSDKPython2.XFAWidget.GetVAlign | ( |  | ) |

获取文本垂直对齐方式。

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

## ◆ GetValue()

def FoxitPDFSDKPython2.XFAWidget.GetValue | ( |  | ) |

获取值字符串。

返回
  值字符串。

## ◆ GetXFAPage()

def FoxitPDFSDKPython2.XFAWidget.GetXFAPage | ( |  | ) |

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

返回
  XFA 页面对象。

## ◆ GetXMLContent()

def FoxitPDFSDKPython2.XFAWidget.GetXMLContent | ( |  | ) |

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

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

## ◆ HasEdge()

def FoxitPDFSDKPython2.XFAWidget.HasEdge | ( |  | edge_pos | ) |

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

参数

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

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

## ◆ IsAllowRichText()

def FoxitPDFSDKPython2.XFAWidget.IsAllowRichText | ( |  | ) |

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

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

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

## ◆ IsChecked()

def FoxitPDFSDKPython2.XFAWidget.IsChecked | ( |  | ) |

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

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

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

## ◆ IsEmpty()

def FoxitPDFSDKPython2.XFAWidget.IsEmpty | ( |  | ) |

检查当前对象是否为空。

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

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

## ◆ IsListBox()

def FoxitPDFSDKPython2.XFAWidget.IsListBox | ( |  | ) |

检查控件是否为列表框。

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

## ◆ IsReadOnly()

def FoxitPDFSDKPython2.XFAWidget.IsReadOnly | ( |  | ) |

检查控件是否为只读。

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

## ◆ IsRequired()

def FoxitPDFSDKPython2.XFAWidget.IsRequired | ( |  | ) |

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

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

## ◆ IsSupportMultiline()

def FoxitPDFSDKPython2.XFAWidget.IsSupportMultiline | ( |  | ) |

检查控件是否支持多行。

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

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

## ◆ IsSupportMultiSelect()

def FoxitPDFSDKPython2.XFAWidget.IsSupportMultiSelect | ( |  | ) |

检查控件是否支持多选。

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

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

## ◆ OnChar()

def FoxitPDFSDKPython2.XFAWidget.OnChar | ( |  | input_char,
|  |  | flags
| ) |  |

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

参数

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

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

## ◆ OnHitTest()

def FoxitPDFSDKPython2.XFAWidget.OnHitTest | ( |  | point | ) |

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

参数

  [in] | point | 要测试的点。

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

## ◆ OnKeyDown()

def FoxitPDFSDKPython2.XFAWidget.OnKeyDown | ( |  | key_code,
|  |  | flags
| ) |  |

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

参数

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

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

## ◆ OnKeyUp()

def FoxitPDFSDKPython2.XFAWidget.OnKeyUp | ( |  | key_code,
|  |  | flags
| ) |  |

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

参数

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

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

## ◆ OnLButtonDoubleClick()

def FoxitPDFSDKPython2.XFAWidget.OnLButtonDoubleClick | ( |  | point,
|  |  | flags
| ) |  |

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

参数

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

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

## ◆ OnLButtonDown()

def FoxitPDFSDKPython2.XFAWidget.OnLButtonDown | ( |  | point,
|  |  | flags
| ) |  |

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

参数

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

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

## ◆ OnLButtonUp()

def FoxitPDFSDKPython2.XFAWidget.OnLButtonUp | ( |  | point,
|  |  | flags
| ) |  |

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

参数

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

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

## ◆ OnMouseEnter()

def FoxitPDFSDKPython2.XFAWidget.OnMouseEnter | ( |  | ) |

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

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

## ◆ OnMouseExit()

def FoxitPDFSDKPython2.XFAWidget.OnMouseExit | ( |  | ) |

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

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

## ◆ OnMouseMove()

def FoxitPDFSDKPython2.XFAWidget.OnMouseMove | ( |  | point,
|  |  | flags
| ) |  |

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

参数

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

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

## ◆ OnRButtonDown()

def FoxitPDFSDKPython2.XFAWidget.OnRButtonDown | ( |  | point,
|  |  | flags
| ) |  |

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

参数

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

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

## ◆ OnRButtonUp()

def FoxitPDFSDKPython2.XFAWidget.OnRButtonUp | ( |  | point,
|  |  | flags
| ) |  |

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

参数

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

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

## ◆ ResetData()

def FoxitPDFSDKPython2.XFAWidget.ResetData | ( |  | ) |

重置 XFA 控件数据。

返回
  无。

## ◆ SetCheckState()

def FoxitPDFSDKPython2.XFAWidget.SetCheckState | ( |  | is_checked | ) |

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

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

参数

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

返回
  无。

## ◆ SetDefaultValue()

def FoxitPDFSDKPython2.XFAWidget.SetDefaultValue | ( |  | value | ) |

设置默认值字符串。

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

参数

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

返回
  无。

## ◆ SetImage()

def FoxitPDFSDKPython2.XFAWidget.SetImage | ( |  | image | ) |

为当前 XFA 控件设置图像。

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

参数

  [in] | image | 将设置到当前 XFA 控件的图像。 目前，此函数仅支持以下图像类型： FoxitPDFSDKPython2.Image.e_BMP FoxitPDFSDKPython2.Image.e_PNG FoxitPDFSDKPython2.Image.e_JPG FoxitPDFSDKPython2.Image.e_GIF FoxitPDFSDKPython2.Image.e_TIF 如果尝试设置其他不支持的图像类型，将抛出异常 FoxitPDFSDKPython2.e_ErrUnsupported 。

返回
  无。

## ◆ SetOptions()

def FoxitPDFSDKPython2.XFAWidget.SetOptions | ( |  | option_array | ) |

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

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

参数

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

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

## ◆ SetValue()

def FoxitPDFSDKPython2.XFAWidget.SetValue | ( |  | value | ) |

设置值字符串。

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

参数

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

返回
  无。

## ◆ ValidateValue()

def FoxitPDFSDKPython2.XFAWidget.ValidateValue | ( |  | value,
|  |  | format
| ) |  |

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

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

参数

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

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

## 类成员变量说明

## ◆ e_WidgethAlignTypeLeft

FoxitPDFSDKPython2.XFAWidget.e_WidgethAlignTypeLeft = _fsdk.XFAWidget_e_WidgethAlignTypeLeft
| static

分散对齐所有行以填充可用区域。

将文本对齐到可用区域的左边缘。