Foxit PDF SDK

Public 成员函数 | 静态 Public 属性 | 所有成员列表
FSDK::XFAWidget类 参考

## Public 成员函数
| GetBitmap ()
| 获取当前 XFA 小部件的位图。 更多...
| GetDefaultValue ()
| 获取默认值字符串。 更多...
| GetHAlign ()
| 获取文本水平对齐。 更多...
| GetIndex ()
| 获取 XFA 小部件在相关 XFA 页面中的索引。 更多...
| GetJavaScript ()
| 获取当前 XFA 小部件验证的 JavaScript。 更多...
| GetName (type)
| 获取小部件名称。 更多...
| GetOptions ()
| 获取选择列表或互斥组（仅适用于单选按钮）的选项。 更多...
| GetPresence ()
| 获取 XFA 小部件的存在属性。 更多...
| GetRect ()
| 获取 XFA 小部件的矩形。 更多...
| GetSignature ()
| 从当前 XFA 小部件获取签名对象。 更多...
| GetToolTip ()
| 获取工具提示字符串。 更多...
| GetType ()
| 获取 XFA 小部件的类型。 更多...
| GetVAlign ()
| 获取文本垂直对齐。 更多...
| GetValue ()
| 获取值字符串。 更多...
| GetXFAPage ()
| 获取相关的 XFA 页面，当前 XFA 小部件属于该页面。 更多...
| GetXMLContent ()
| 获取当前 XFA 小部件的 xml 内容。 更多...
| HasEdge (edge_pos)
| 检查指定位置的边缘是否存在。 更多...
| IsAllowRichText ()
| 检查小部件是否允许富文本格式。 更多...
| IsChecked ()
| 检查当前 XFA 小部件是否被选中。 更多...
| IsListBox ()
| 检查小部件是否为列表框。 更多...
| IsReadOnly ()
| 检查小部件是否为只读。 更多...
| IsRequired ()
| 检查小部件在提交表单操作导出时是否需要具有值。 更多...
| IsSupportMultiline ()
| 检查小部件是否支持多行。 更多...
| IsSupportMultiSelect ()
| 检查小部件是否支持多选。 更多...
| OnChar (input_char, flags)
| 当正在输入字符代码时调用此函数。 更多...
| OnHitTest (point)
| 调用此函数对指定点进行命中测试。 更多...
| OnKeyDown (key_code, flags)
| 当键盘上的键按下时调用此函数。 更多...
| OnKeyUp (key_code, flags)
| 当键盘上的键释放时调用此函数。 更多...
| OnLButtonDoubleClick (point, flags)
| 当鼠标左键双击时调用此函数。 更多...
| OnLButtonDown (point, flags)
| 当鼠标左键按下时调用此函数。 更多...
| OnLButtonUp (point, flags)
| 当鼠标左键释放时调用此函数。 更多...
| OnMouseEnter ()
| 当鼠标进入当前 XFA 小部件时调用此函数。 更多...
| OnMouseExit ()
| 当鼠标退出时调用此函数。 更多...
| OnMouseMove (point, flags)
| 当鼠标移动时调用此函数。 更多...
| OnRButtonDown (point, flags)
| 当鼠标右键按下时调用此函数。 更多...
| OnRButtonUp (point, flags)
| 当鼠标右键释放时调用此函数。 更多...
| ResetData ()
| 重置 XFA 小部件数据。 更多...
| SetCheckState (is_checked)
| 设置当前 XFA 小部件的选中状态。 更多...
| SetDefaultValue (value)
| 设置默认值字符串。 更多...
| SetImage (image)
| 为当前 XFA 小部件设置图像。 更多...
| SetValue (value)
| 设置值字符串。 更多...
| ValidateValue (value, format)
| 验证值是否符合当前 XFA 小部件的格式。 更多...

## 静态 Public 属性
static | e_HitTestAreaUnknown: number static e_HitTestAreaClient: number static e_HitTestAreaTitleBar: number static e_HitTestAreaHyperLink: number static e_WidgetTypeBarcode: number static e_WidgetTypePushButton: number static e_WidgetTypeCheckButton: number static e_WidgetTypeArc: number static e_WidgetTypeDateTimeEdit: number static e_WidgetTypeNumericEdit: number static e_WidgetTypeSignature: number static e_WidgetTypeChoiceList: number static e_WidgetTypeImageEdit: number static e_WidgetTypeLine: number static e_WidgetTypePasswordEdit: number static e_WidgetTypeRadioButton: number static e_WidgetTypeRectangle: number static e_WidgetTypeTextEdit: number static e_WidgetTypeUnknown: number static e_WidgetTypeExclGroup: number static e_WidgetTypeImage: number static e_PresenceUnknown: number static e_PresenceVisible: number static e_PresenceHidden: number static e_PresenceInactive: number static e_PresenceInvisible: number static e_WidgetNameTypeField: number static e_WidgetNameTypeCaption: number static e_WidgetNameTypeFullName: number static e_WidgethAlignTypeCenter: number static e_WidgethAlignTypeJustify: number static e_WidgethAlignTypeJustifyAll: number static e_WidgethAlignTypeLeft: number static e_WidgethAlignTypeRadix: number static e_WidgethAlignTypeRight: number static e_WidgetvAlignTypeTop: number static e_WidgetvAlignTypeBottom: number static e_WidgetvAlignTypeMiddle: number static e_WidgetEdgePositionTop: number static e_WidgetEdgePositionRight: number static e_WidgetEdgePositionBottom: number static e_WidgetEdgePositionLeft: number IsEmpty()
| XFA 小部件命中测试区域的枚举。 更多...

## 详细描述

类 FSDK.XFAWidget 表示从 XFA 页面对象检索的 XFA 小部件。
要访问 XFA 小部件的菜单，请使用 FSDK.XFAWidget 对象构造 FSDK.WidgetMenu 对象。

参见
  FSDK.WidgetMenu

## 成员函数说明

## ◆ GetBitmap()

FSDK::XFAWidget::GetBitmap | ( |  | ) |

获取当前 XFA 小部件的位图。

仅当当前 XFA 小部件的类型为 FSDK.XFAWidget.e_WidgetTypeImageEdit 或 FSDK.XFAWidget.e_WidgetTypeImage 时适用。对于不适用的类型，此函数将 抛出异常 FSDK.e_ErrUnsupported。

返回
  当前 XFA 小部件的位图。

## ◆ GetDefaultValue()

FSDK::XFAWidget::GetDefaultValue | ( |  | ) |

获取默认值字符串。

返回
  默认值字符串。

## ◆ GetHAlign()

FSDK::XFAWidget::GetHAlign | ( |  | ) |

获取文本水平对齐。

返回
  文本水平对齐。请参阅从 FSDK.XFAWidget.e_WidgethAlignTypeLeft 开始的值， 并且该值应为这些值之一。

## ◆ GetIndex()

FSDK::XFAWidget::GetIndex | ( |  | ) |

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

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

## ◆ GetJavaScript()

FSDK::XFAWidget::GetJavaScript | ( |  | ) |

获取当前 XFA 小部件验证的 JavaScript。

返回
  当前 XFA 小部件验证的 JavaScript。

## ◆ GetName()

FSDK::XFAWidget::GetName | ( | type |  | ) |

获取小部件名称。

参数

  [in] | type | 名称类型。请参阅从 FSDK.XFAWidget.e_WidgetNameTypeField 开始的值， 并且该值应为这些值之一。

返回
  小部件名称字符串。

## ◆ GetOptions()

FSDK::XFAWidget::GetOptions | ( |  | ) |

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

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

返回
  选择选项数组。

## ◆ GetPresence()

FSDK::XFAWidget::GetPresence | ( |  | ) |

获取 XFA 小部件的存在属性。

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

返回
  XFA 小部件的存在属性。

## ◆ GetRect()

FSDK::XFAWidget::GetRect | ( |  | ) |

获取 XFA 小部件的矩形。

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

返回
  XFA 小部件的矩形。

## ◆ GetSignature()

FSDK::XFAWidget::GetSignature | ( |  | ) |

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

仅当当前 XFA 小部件表示签名时适用。 对于不适用的类型，此函数将抛出异常 FSDK.e_ErrUnsupported。

返回
  签名对象。

## ◆ GetToolTip()

FSDK::XFAWidget::GetToolTip | ( |  | ) |

获取工具提示字符串。

返回
  工具提示字符串。

## ◆ GetType()

FSDK::XFAWidget::GetType | ( |  | ) |

获取 XFA 小部件的类型。

返回
  XFA 小部件类型。请参阅从 FSDK.XFAWidget.e_WidgetTypeBarcode 开始的值， 并且该值应为这些值之一。

## ◆ GetVAlign()

FSDK::XFAWidget::GetVAlign | ( |  | ) |

获取文本垂直对齐。

返回
  文本垂直对齐。请参阅从 FSDK.XFAWidget.e_WidgetvAlignTypeTop 开始的值， 并且该值应为这些值之一。

## ◆ GetValue()

FSDK::XFAWidget::GetValue | ( |  | ) |

获取值字符串。

返回
  值字符串。

## ◆ GetXFAPage()

FSDK::XFAWidget::GetXFAPage | ( |  | ) |

获取相关的 XFA 页面，当前 XFA 小部件属于该页面。

返回
  XFA 页面对象。

## ◆ GetXMLContent()

FSDK::XFAWidget::GetXMLContent | ( |  | ) |

获取当前 XFA 小部件的 xml 内容。

返回
  当前 XFA 小部件的 xml 内容。

## ◆ HasEdge()

FSDK::XFAWidget::HasEdge | ( | edge_pos |  | ) |

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

参数

  [in] | edge_pos | 边缘位置，用于指定将检查哪个边缘。请参阅从 FSDK.XFAWidget.e_WidgetEdgePositionTop 开始的值，并且该值应为这些值之一。

返回
  true 表示指定位置的边缘存在，而 false 表示不存在这样的边缘。

## ◆ IsAllowRichText()

FSDK::XFAWidget::IsAllowRichText | ( |  | ) |

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

只有类型为 FSDK.XFAWidget.e_WidgetTypeTextEdit 的文本编辑小部件支持富文本。

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

## ◆ IsChecked()

FSDK::XFAWidget::IsChecked | ( |  | ) |

检查当前 XFA 小部件是否被选中。

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

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

## ◆ IsListBox()

FSDK::XFAWidget::IsListBox | ( |  | ) |

检查小部件是否为列表框。

返回
  true 表示小部件是列表框，而 false 表示不是。

## ◆ IsReadOnly()

FSDK::XFAWidget::IsReadOnly | ( |  | ) |

检查小部件是否为只读。

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

## ◆ IsRequired()

FSDK::XFAWidget::IsRequired | ( |  | ) |

检查小部件在提交表单操作导出时是否需要具有值。

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

## ◆ IsSupportMultiline()

FSDK::XFAWidget::IsSupportMultiline | ( |  | ) |

检查小部件是否支持多行。

只有类型为 FSDK.XFAWidget.e_WidgetTypeTextEdit 的文本编辑小部件支持多行。

返回
  true 表示小部件支持，而 false 表示不支持。

## ◆ IsSupportMultiSelect()

FSDK::XFAWidget::IsSupportMultiSelect | ( |  | ) |

检查小部件是否支持多选。

只有列表框小部件支持多行选择，其类型为 FSDK.XFAWidget.e_WidgetTypeChoiceList， 并且当函数调用 FSDK.XFAWidget.IsListBox 返回 true 时。

返回
  true 表示小部件支持，而 false 表示不支持。

## ◆ OnChar()

FSDK::XFAWidget::OnChar | ( | input_char | ,
|  | flags |
| ) |  |

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

参数

  [in] | input_char | 字符代码，采用 UTF16-LE 编码。
  [in] | flags | 事件标志。请参阅从 FSDK.Filler.e_EventFlagShiftKey 开始的值， 并且该值应为这些值之一或这些值的组合。

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

## ◆ OnHitTest()

FSDK::XFAWidget::OnHitTest | ( | point |  | ) |

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

参数

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

返回
  命中测试区域。请参阅从 FSDK.XFAWidget.e_HitTestAreaUnknown 开始的值， 并且该值应为这些值之一。

## ◆ OnKeyDown()

FSDK::XFAWidget::OnKeyDown | ( | key_code | ,
|  | flags |
| ) |  |

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

参数

  [in] | key_code | 键代码。请参阅从 FSDK.Filler.e_VkeyUnknown 开始的值， 并且该值应为这些值之一。
  [in] | flags | 事件标志。请参阅从 FSDK.Filler.e_EventFlagShiftKey 开始的值， 并且该值应为这些值之一或这些值的组合。

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

## ◆ OnKeyUp()

FSDK::XFAWidget::OnKeyUp | ( | key_code | ,
|  | flags |
| ) |  |

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

参数

  [in] | key_code | 键代码。请参阅从 FSDK.Filler.e_VkeyUnknown 开始的值， 并且该值应为这些值之一。
  [in] | flags | 事件标志。请参阅从 FSDK.Filler.e_EventFlagShiftKey 开始的值， 并且该值应为这些值之一或这些值的组合。

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

## ◆ OnLButtonDoubleClick()

FSDK::XFAWidget::OnLButtonDoubleClick | ( | point | ,
|  | flags |
| ) |  |

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

参数

  [in] | point | XFA 页面中鼠标左键双击的点，在 PDF 坐标系中。
  [in] | flags | 事件标志。请参阅从 FSDK.Filler.e_EventFlagShiftKey 开始的值， 并且该值应为这些值之一或这些值的组合。

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

## ◆ OnLButtonDown()

FSDK::XFAWidget::OnLButtonDown | ( | point | ,
|  | flags |
| ) |  |

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

参数

  [in] | point | XFA 页面中鼠标左键按下的点，在 PDF 坐标系中。
  [in] | flags | 事件标志。请参阅从 FSDK.Filler.e_EventFlagShiftKey 开始的值， 并且该值应为这些值之一或这些值的组合。

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

## ◆ OnLButtonUp()

FSDK::XFAWidget::OnLButtonUp | ( | point | ,
|  | flags |
| ) |  |

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

参数

  [in] | point | XFA 页面中鼠标左键释放的点，在 PDF 坐标系中。
  [in] | flags | 事件标志。请参阅从 FSDK.Filler.e_EventFlagShiftKey 开始的值， 并且该值应为这些值之一或这些值的组合。

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

## ◆ OnMouseEnter()

FSDK::XFAWidget::OnMouseEnter | ( |  | ) |

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

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

## ◆ OnMouseExit()

FSDK::XFAWidget::OnMouseExit | ( |  | ) |

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

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

## ◆ OnMouseMove()

FSDK::XFAWidget::OnMouseMove | ( | point | ,
|  | flags |
| ) |  |

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

参数

  [in] | point | XFA 页面中鼠标左键移动的点，在 PDF 坐标系中。
  [in] | flags | 事件标志。请参阅从 FSDK.Filler.e_EventFlagShiftKey 开始的值， 并且该值应为这些值之一或这些值的组合。

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

## ◆ OnRButtonDown()

FSDK::XFAWidget::OnRButtonDown | ( | point | ,
|  | flags |
| ) |  |

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

参数

  [in] | point | XFA 页面中鼠标右键按下的点，在 PDF 坐标系中。
  [in] | flags | 事件标志。请参阅从 FSDK.Filler.e_EventFlagShiftKey 开始的值， 并且该值应为这些值之一或这些值的组合。

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

## ◆ OnRButtonUp()

FSDK::XFAWidget::OnRButtonUp | ( | point | ,
|  | flags |
| ) |  |

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

参数

  [in] | point | XFA 页面中鼠标右键释放的点，在 PDF 坐标系中。
  [in] | flags | 事件标志。请参阅从 FSDK.Filler.e_EventFlagShiftKey 开始的值， 并且该值应为这些值之一或这些值的组合。

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

## ◆ ResetData()

FSDK::XFAWidget::ResetData | ( |  | ) |

重置 XFA 小部件数据。

返回
  无。

## ◆ SetCheckState()

FSDK::XFAWidget::SetCheckState | ( | is_checked |  | ) |

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

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

参数

  [in] | is_checked | true 表示当前 XFA 小部件将被选中， 而 false 表示它将不被选中。

返回
  无。

## ◆ SetDefaultValue()

FSDK::XFAWidget::SetDefaultValue | ( | value |  | ) |

设置默认值字符串。

仅对类型为 FSDK.XFAWidget.e_WidgetTypeTextEdit、FSDK.XFAWidget.e_WidgetTypeNumericEdit、 FSDK.XFAWidget.e_WidgetTypePasswordEdit 或 FSDK.XFAWidget.e_WidgetTypeDateTimeEdit 的 XFA 小部件有用。

参数

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

返回
  无。

## ◆ SetImage()

FSDK::XFAWidget::SetImage | ( | image |  | ) |

为当前 XFA 小部件设置图像。

仅当当前 XFA 小部件的类型为 FSDK.XFAWidget.e_WidgetTypeImageEdit 时适用。 对于不适用的类型，此函数将抛出异常 FSDK.e_ErrUnsupported。

参数

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

返回
  无。

## ◆ SetValue()

FSDK::XFAWidget::SetValue | ( | value |  | ) |

设置值字符串。

仅对类型为 FSDK.XFAWidget.e_WidgetTypeTextEdit、FSDK.XFAWidget.e_WidgetTypeNumericEdit、 FSDK.XFAWidget.e_WidgetTypePasswordEdit 或 FSDK.XFAWidget.e_WidgetTypeDateTimeEdit 的 XFA 小部件有用。

参数

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

返回
  无。

## ◆ ValidateValue()

FSDK::XFAWidget::ValidateValue | ( | value | ,
|  | format |
| ) |  |

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

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

参数

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

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

## 类成员变量说明

## ◆ e_HitTestAreaUnknown

FSDK::XFAWidget::e_HitTestAreaUnknown
| static

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

此枚举的值应单独使用。

命中测试区域：未知。