Foxit PDF SDK定义“表单控件”来将表单字段与其相关的微件注释关联。 一个表单字段可以有一个或多个表单控件,每个表单控件都与一个微件注释关联。 可以通过以下函数检索表单控件对象:
表单控件还提供了获取相关表单字段对象和微件注释对象的函数。
函数 FSDK.Form.AddControl 可用于向表单字段添加新的表单控件,函数 FSDK.Form.RemoveControl 可用于删除表单控件。
- 参见
- FSDK.Form
-
FSDK.Field
◆ GetAlignment()
| FSDK::Control::GetAlignment |
( |
| ) |
|
|
inline |
获取对齐值。
对齐是可变文本的属性,它仅对文本字段、列表框和 组合框作为相关表单字段有用,它们可能包含可变文本作为其内容。
如果相关表单字段是文本字段或列表框并且它有自己的对齐值, 则将忽略文档范围的默认对齐值; 否则,将在这种情况下使用文档范围的默认对齐值。
- 返回
- 对齐值。请参考从 FSDK.e_AlignmentLeft 开始的值,并且 这将是这些值中的一个。
◆ GetDefaultAppearance()
| FSDK::Control::GetDefaultAppearance |
( |
| ) |
|
|
inline |
◆ GetExportValue()
| FSDK::Control::GetExportValue |
( |
| ) |
|
|
inline |
当相关表单字段为复选框或单选按钮时,获取导出映射名称。
适用于复选框和单选按钮作为相关表单字段。 如果相关表单字段是其他字段类型,此函数将返回空字符串。
- 返回
- 导出映射名称。
◆ GetField()
| FSDK::Control::GetField |
( |
| ) |
|
|
inline |
◆ GetIndex()
| FSDK::Control::GetIndex |
( |
| ) |
|
|
inline |
获取当前表单控件在相关表单字段的所有控件中的索引。
- 返回
- 表单控件的索引。
◆ GetWidget()
| FSDK::Control::GetWidget |
( |
| ) |
|
|
inline |
◆ GetWidgetDict()
| FSDK::Control::GetWidgetDict |
( |
| ) |
|
|
inline |
获取相关小部件注释的字典。
- 返回
- 相关小部件注释的字典。如果有任何错误,函数将返回 null。
◆ IsChecked()
| FSDK::Control::IsChecked |
( |
| ) |
|
|
inline |
当相关表单字段为复选框或单选按钮时,检查当前表单控件是否被选中。
适用于复选框和单选按钮作为相关表单字段。 如果相关表单字段是其他字段类型,此函数将返回 false。
- 返回
- true 表示已选中,false 表示未选中。
◆ IsDefaultChecked()
| FSDK::Control::IsDefaultChecked |
( |
| ) |
|
|
inline |
当相关表单字段为复选框或单选按钮时,检查当前表单控件默认是否被选中。
适用于复选框和单选按钮作为相关表单字段。 如果相关表单字段是其他字段类型,此函数将返回 false。
- 返回
- true 表示默认选中,false 表示默认未选中。
◆ IsEmpty()
| FSDK::Control::IsEmpty |
( |
| ) |
|
|
inline |
检查当前对象是否为空。
当当前对象为空时,这意味着当前对象是无用的。
- 返回
- true 表示当前对象为空,而 false 表示不是。
◆ SetAlignment()
| FSDK::Control::SetAlignment |
( |
|
alignment | ) |
|
|
inline |
设置当前表单控件的对齐属性。
对齐是可变文本的属性,它仅对文本字段、列表框和 组合框作为相关表单字段有用,它们可能包含可变文本作为其内容。
如果相关表单字段是文本字段或列表框并且它有自己的对齐值, 则将忽略文档范围的默认对齐值; 否则,将在这种情况下使用文档范围的默认对齐值。
- 参数
-
- 返回
- 无。
◆ SetChecked()
| FSDK::Control::SetChecked |
( |
|
checked_status | ) |
|
|
inline |
当相关表单字段为复选框或单选按钮时,设置当前表单控件的选中状态。
适用于复选框和单选按钮作为相关表单字段。 如果相关表单字段是其他字段类型,此函数将不执行任何操作。
- 参数
-
| [in] | checked_status | true 表示选中,false 表示未选中。 |
- 返回
- 无。
◆ SetDefaultAppearance()
| FSDK::Control::SetDefaultAppearance |
( |
|
default_ap | ) |
|
|
inline |
设置默认外观数据。
- 参数
-
| [in] | default_ap | 新的默认外观。输入数据的 flags 可用于决定 哪些信息将使用新数据更新;对于那些不更新的数据, 它们将继续使用旧数据。
如果输入的默认外观数据的 text_size 为0,则意味着应自动计算文本大小。 |
- 返回
- 无。
◆ SetDefaultChecked()
| FSDK::Control::SetDefaultChecked |
( |
|
checked_status | ) |
|
|
inline |
当相关表单字段为复选框或单选按钮时,设置当前表单控件的默认选中状态。
适用于复选框和单选按钮作为相关表单字段。 如果相关表单字段是其他字段类型,此函数将不执行任何操作。
- 参数
-
| [in] | checked_status | true 表示默认选中,false 表示默认未选中。 |
- 返回
- 无。
◆ SetExportValue()
| FSDK::Control::SetExportValue |
( |
|
value | ) |
|
|
inline |
当相关表单字段为复选框或单选按钮时,设置导出映射名称。
适用于复选框和单选按钮作为相关表单字段。 如果相关表单字段是其他字段类型,此函数将不执行任何操作。
- 参数
-
| [in] | value | 新的导出映射名称。它不应该是空字符串。 |
- 返回
- 无。