Foxit PDF SDK
FSControl类 参考
类 FSControl 继承关系图:
FSBase

构造函数

(FSField *) - getField
 获取相关的表单字段。
更多...
 
(int) - getIndex
 获取当前表单控件在相关表单字段的所有控件中的索引。
更多...
 
(FSWidget *) - getWidget
 获取相关的控件注释。
更多...
 
(FSPDFDictionary *) - getWidgetDict
 获取相关控件注释的字典。
更多...
 
(id) - initWithOther:
 构造函数,使用另一个表单控件对象。
更多...
 
(BOOL) - isChecked
 检查当相关表单字段是复选框或单选按钮时,当前表单控件是否被选中。
更多...
 
(BOOL) - isDefaultChecked
 检查当相关表单字段是复选框或单选按钮时,当前表单控件是否默认被选中。
更多...
 
(BOOL) - isEmpty
 检查当前对象是否为空。
更多...
 
(void) - setChecked:
 当相关表单字段是复选框或单选按钮时,设置当前表单控件的选中状态。
更多...
 
(void) - setDefaultChecked:
 当相关表单字段是复选框或单选按钮时,设置当前表单控件的默认选中状态。
更多...
 

属性

FSAlignment alignment
 获取对齐值。
更多...
 
FSDefaultAppearance * defaultAppearance
 获取默认外观数据。

 
NSString * exportValue
 当相关表单字段是复选框或单选按钮时,获取导出映射名称。
更多...
 

详细描述

Foxit PDF SDK定义"表单控件"以将表单字段与其相关的控件注释关联。 表单字段可能有一个或多个表单控件,每个表单控件都与一个控件注释关联。 表单控件对象可以通过以下函数检索:

表单控件还提供获取相关表单字段对象和控件注释对象的函数。
函数FSForm::addControl:field_name:field_type:rect:可用于向表单字段添加新的表单控件,函数 FSForm::removeControl:可用于删除表单控件。

参见
FSForm
FSField

函数文档

◆ getField()

- (FSField *) getField

获取相关的表单字段。

返回
相关的表单字段对象。

◆ getIndex()

- (int) getIndex

获取当前表单控件在相关表单字段的所有控件中的索引。

返回
表单控件的索引。

◆ getWidget()

- (FSWidget *) getWidget

获取相关的控件注释。

返回
相关的控件注释。

◆ getWidgetDict()

- (FSPDFDictionary *) getWidgetDict

获取相关控件注释的字典。

返回
相关控件注释的字典。如果有任何错误,函数将返回nil

◆ initWithOther:()

- (id) initWithOther: (FSControl*)  other

构造函数,使用另一个表单控件对象。

参数
[in]other另一个表单控件对象。

◆ isChecked()

- (BOOL) isChecked

检查当相关表单字段是复选框或单选按钮时,当前表单控件是否被选中。

适用于复选框和单选按钮作为相关表单字段。 如果相关表单字段是其他字段类型,此函数将返回NO

返回
YES 表示选中,NO 表示未选中。

◆ isDefaultChecked()

- (BOOL) isDefaultChecked

检查当相关表单字段是复选框或单选按钮时,当前表单控件是否默认被选中。

适用于复选框和单选按钮作为相关表单字段。 如果相关表单字段是其他字段类型,此函数将返回NO

返回
YES 表示默认选中,NO 表示默认未选中。

◆ isEmpty()

- (BOOL) isEmpty

检查当前对象是否为空。

当当前对象为空时,意味着当前对象无用。

返回
YES 表示当前对象为空,NO 表示非空。

◆ setChecked:()

- (void) setChecked: (BOOL)  checked_status

当相关表单字段是复选框或单选按钮时,设置当前表单控件的选中状态。

适用于复选框和单选按钮作为相关表单字段。 如果相关表单字段是其他字段类型,此函数不执行任何操作。

参数
[in]checked_statusYES 表示选中,NO 表示未选中。
返回
无。

◆ setDefaultChecked:()

- (void) setDefaultChecked: (BOOL)  checked_status

当相关表单字段是复选框或单选按钮时,设置当前表单控件的默认选中状态。

适用于复选框和单选按钮作为相关表单字段。 如果相关表单字段是其他字段类型,此函数不执行任何操作。

参数
[in]checked_statusYES 表示默认选中,NO 表示默认未选中。
返回
无。

属性说明

◆ alignment

- (FSAlignment) alignment
readwritenonatomicassign

获取对齐值。

对齐是可变文本的属性,仅对作为相关表单字段的文本字段、列表框和 组合框有用,这些字段可能包含可变文本作为其内容。
如果相关表单字段是文本字段或列表框且有自己的对齐值, 则将忽略文档范围的默认对齐值; 否则,在这种情况下将使用文档范围的默认对齐值。

◆ exportValue

- (NSString *) exportValue
readwritenonatomicweak

当相关表单字段是复选框或单选按钮时,获取导出映射名称。

适用于复选框和单选按钮作为相关表单字段。 如果相关表单字段是其他字段类型,此函数将返回空字符串。