Foxit PDF SDK

构造函数 | 属性 | 所有成员列表
FSXFAWidget类 参考
类 FSXFAWidget 继承关系图:

## 构造函数
(FSBitmap *) | - getBitmap
| 获取当前 XFA 控件的位图。 更多...
(FSXFAWidgetWidgetHAlignType) | - getHAlign
| 获取文本水平对齐方式。 更多...
(int) | - getIndex
| 获取 XFA 控件在相关 XFA 页面中的索引。 更多...
(NSString *) | - getJavaScript
| 获取当前 XFA 控件验证的 JavaScript。 更多...
(NSString *) | - getName:
| 获取控件名称。 更多...
(FSWidgetChoiceOptionArray *) | - getOptions
| 获取选择列表或排斥组（仅用于单选按钮）的选项。 更多...
(FSXFAWidgetPresenceProperty) | - getPresence
| 获取 XFA 控件的存在属性。 更多...
(FSRectF *) | - getRect
| 获取 XFA 控件的矩形。 更多...
(FSSignature *) | - getSignature
| 从当前 XFA 控件获取签名对象。 更多...
(NSString *) | - getToolTip
| 获取工具提示字符串。 更多...
(FSXFAWidgetWidgetType) | - getType
| 获取 XFA 控件的类型。 更多...
(FSXFAWidgetWidgetVAlignType) | - getVAlign
| 获取文本垂直对齐方式。 更多...
(FSXFAPage *) | - getXFAPage
| 获取当前 XFA 控件所属的相关 XFA 页面。 更多...
(NSString *) | - getXMLContent
| 获取当前 XFA 控件的 XML 内容。 更多...
(BOOL) | - hasEdge:
| 检查指定位置的边框是否存在。 更多...
(id) | - initWithOther:
| 构造函数，使用另一个 XFA 控件对象。 更多...
(BOOL) | - isAllowRichText
| 检查控件是否允许富文本格式。 更多...
(BOOL) | - isChecked
| 检查当前 XFA 控件是否已选中。 更多...
(BOOL) | - isEmpty
| 检查当前对象是否为空。 更多...
(BOOL) | - isListBox
| 检查控件是否为列表框。 更多...
(BOOL) | - isReadOnly
| 检查控件是否为只读。 更多...
(BOOL) | - isRequired
| 检查控件在通过提交表单操作导出时是否需要值。 更多...
(BOOL) | - isSupportMultiline
| 检查控件是否支持多行。 更多...
(BOOL) | - isSupportMultiSelect
| 检查控件是否支持多选。 更多...
(BOOL) | - onChar:flags:
| 当输入字符代码时调用此函数。 更多...
(FSXFAWidgetHitTestArea) | - onHitTest:
| 调用此函数对指定点进行命中测试。 更多...
(BOOL) | - onKeyDown:flags:
| 当键盘按键按下时调用此函数。 更多...
(BOOL) | - onKeyUp:flags:
| 当键盘按键释放时调用此函数。 更多...
(BOOL) | - onLButtonDoubleClick:flags:
| 当鼠标左键双击时调用此函数。 更多...
(BOOL) | - onLButtonDown:flags:
| 当鼠标左键按下时调用此函数。 更多...
(BOOL) | - onLButtonUp:flags:
| 当鼠标左键释放时调用此函数。 更多...
(BOOL) | - onMouseEnter
| 当鼠标进入当前 XFA 控件时调用此函数。 更多...
(BOOL) | - onMouseExit
| 当鼠标退出时调用此函数。 更多...
(BOOL) | - onMouseMove:flags:
| 当鼠标移动时调用此函数。 更多...
(BOOL) | - onRButtonDown:flags:
| 当鼠标右键按下时调用此函数。 更多...
(BOOL) | - onRButtonUp:flags:
| 当鼠标右键释放时调用此函数。 更多...
(void) | - resetData
| 重置 XFA 控件数据。 更多...
(void) | - setCheckState:
| 设置当前 XFA 控件的选中状态。 更多...
(void) | - setImage:
| 为当前 XFA 控件设置图像。 更多...
(BOOL) | - setOptions:
| 设置选择列表或排斥组（仅用于单选按钮）的选项。 更多...
(BOOL) | - validateValue:format:
| 验证值是否符合当前 XFA 控件的格式。 更多...

## 属性
NSString * | defaultValue
| 获取默认值字符串。
NSString * | value
| 获取值字符串。

## 详细描述

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

参见
  FSWidgetMenu

## 函数文档

## ◆ getBitmap()

- (FSBitmap *) getBitmap |  |  |

获取当前 XFA 控件的位图。

仅适用于当前 XFA 控件类型为 FSXFAWidgetWidgetTypeImageEdit 或 FSXFAWidgetWidgetTypeImage 的情况。对于不适用的类型，此函数将 抛出异常 FSErrUnsupported。

返回
  当前 XFA 控件的位图。

## ◆ getHAlign()

- (FSXFAWidgetWidgetHAlignType) getHAlign |  |  |

获取文本水平对齐方式。

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

## ◆ getIndex()

- (int) getIndex |  |  |

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

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

## ◆ getJavaScript()

- (NSString *) getJavaScript |  |  |

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

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

## ◆ getName:()

- (NSString *) getName: |  | (FSXFAWidgetWidgetNameType) | type |

获取控件名称。

参数

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

返回
  控件名称字符串。

## ◆ getOptions()

- (FSWidgetChoiceOptionArray *) getOptions |  |  |

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

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

返回
  选择选项数组。

## ◆ getPresence()

- (FSXFAWidgetPresenceProperty) getPresence |  |  |

获取 XFA 控件的存在属性。

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

返回
  XFA 控件的存在属性。

## ◆ getRect()

- (FSRectF *) getRect |  |  |

获取 XFA 控件的矩形。

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

返回
  XFA 控件的矩形。

## ◆ getSignature()

- (FSSignature *) getSignature |  |  |

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

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

返回
  签名对象。

## ◆ getToolTip()

- (NSString *) getToolTip |  |  |

获取工具提示字符串。

返回
  工具提示字符串。

## ◆ getType()

- (FSXFAWidgetWidgetType) getType |  |  |

获取 XFA 控件的类型。

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

## ◆ getVAlign()

- (FSXFAWidgetWidgetVAlignType) getVAlign |  |  |

获取文本垂直对齐方式。

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

## ◆ getXFAPage()

- (FSXFAPage *) getXFAPage |  |  |

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

返回
  XFA 页面对象。

## ◆ getXMLContent()

- (NSString *) getXMLContent |  |  |

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

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

## ◆ hasEdge:()

- (BOOL) hasEdge: |  | (FSXFAWidgetWidgetEdgePosition) | edge_pos |

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

参数

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

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

## ◆ initWithOther:()

- (id) initWithOther: |  | (FSXFAWidget*) | other |

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

参数

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

## ◆ isAllowRichText()

- (BOOL) isAllowRichText |  |  |

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

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

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

## ◆ isChecked()

- (BOOL) isChecked |  |  |

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

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

返回
  YES 表示已选中，NO 表示未选中或失败。

## ◆ isEmpty()

- (BOOL) isEmpty |  |  |

检查当前对象是否为空。

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

返回
  YES 表示当前对象为空，NO 表示不为空。

## ◆ isListBox()

- (BOOL) isListBox |  |  |

检查控件是否为列表框。

返回
  YES 表示控件是列表框，NO 表示不是。

## ◆ isReadOnly()

- (BOOL) isReadOnly |  |  |

检查控件是否为只读。

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

## ◆ isRequired()

- (BOOL) isRequired |  |  |

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

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

## ◆ isSupportMultiline()

- (BOOL) isSupportMultiline |  |  |

检查控件是否支持多行。

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

返回
  YES 表示控件支持多行，NO 表示不支持。

## ◆ isSupportMultiSelect()

- (BOOL) isSupportMultiSelect |  |  |

检查控件是否支持多选。

只有列表框控件支持多选，其类型为 FSXFAWidgetWidgetTypeChoiceList 且 函数 FSXFAWidget::isListBox 的返回值为 YES。

返回
  YES 表示控件支持多选，NO 表示不支持。

## ◆ onChar:flags:()

- (BOOL) onChar: |  | (int) | input_char
flags: |  | (unsigned int) | flags

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

参数

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

返回
  YES 表示成功，NO 表示失败。

## ◆ onHitTest:()

- (FSXFAWidgetHitTestArea) onHitTest: |  | (FSPointF*) | point |

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

参数

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

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

## ◆ onKeyDown:flags:()

- (BOOL) onKeyDown: |  | (unsigned int) | key_code
flags: |  | (unsigned int) | flags

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

参数

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

返回
  YES 表示成功，NO 表示失败。

## ◆ onKeyUp:flags:()

- (BOOL) onKeyUp: |  | (unsigned int) | key_code
flags: |  | (unsigned int) | flags

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

参数

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

返回
  YES 表示成功，NO 表示失败。

## ◆ onLButtonDoubleClick:flags:()

- (BOOL) onLButtonDoubleClick: |  | (FSPointF*) | point
flags: |  | (unsigned int) | flags

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

参数

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

返回
  YES 表示成功，NO 表示失败。

## ◆ onLButtonDown:flags:()

- (BOOL) onLButtonDown: |  | (FSPointF*) | point
flags: |  | (unsigned int) | flags

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

参数

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

返回
  YES 表示成功，NO 表示失败。

## ◆ onLButtonUp:flags:()

- (BOOL) onLButtonUp: |  | (FSPointF*) | point
flags: |  | (unsigned int) | flags

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

参数

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

返回
  YES 表示成功，NO 表示失败。

## ◆ onMouseEnter()

- (BOOL) onMouseEnter |  |  |

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

返回
  YES 表示成功，NO 表示失败。

## ◆ onMouseExit()

- (BOOL) onMouseExit |  |  |

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

返回
  YES 表示成功，NO 表示失败。

## ◆ onMouseMove:flags:()

- (BOOL) onMouseMove: |  | (FSPointF*) | point
flags: |  | (unsigned int) | flags

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

参数

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

返回
  YES 表示成功，NO 表示失败。

## ◆ onRButtonDown:flags:()

- (BOOL) onRButtonDown: |  | (FSPointF*) | point
flags: |  | (unsigned int) | flags

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

参数

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

返回
  YES 表示成功，NO 表示失败。

## ◆ onRButtonUp:flags:()

- (BOOL) onRButtonUp: |  | (FSPointF*) | point
flags: |  | (unsigned int) | flags

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

参数

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

返回
  YES 表示成功，NO 表示失败。

## ◆ resetData()

- (void) resetData |  |  |

重置 XFA 控件数据。

返回
  无。

## ◆ setCheckState:()

- (void) setCheckState: |  | (BOOL) | is_checked |

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

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

参数

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

返回
  无。

## ◆ setImage:()

- (void) setImage: |  | (FSImage*) | image |

为当前 XFA 控件设置图像。

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

参数

  [in] | image | 将设置到当前 XFA 控件的图像。 目前，此函数仅支持以下图像类型： FSImageBMP FSImagePNG FSImageJPG FSImageGIF FSImageTIF 如果尝试设置其他不支持的图像类型，将抛出异常 FSErrUnsupported。

返回
  无。

## ◆ setOptions:()

- (BOOL) setOptions: |  | (FSWidgetChoiceOptionArray*) | option_array |

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

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

参数

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

返回
  YES 表示成功，NO 表示失败。

## ◆ validateValue:format:()

- (BOOL) validateValue: |  | (NSString *) | value
format: |  | (NSString *) | format

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

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

参数

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

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