类 FSField 继承关系图:

构造函数
(FSControl *)	- getControl:
	通过索引获取表单控件。更多...

(int)	- getControlCount
	获取表单控件数量。更多...

(int)	- getControlCountWithPDFPage:
	获取指定PDF页面中的表单控件数量。更多...

(FSControl *)	- getControlWithPDFPage:index:
	在指定PDF页面中通过索引获取表单控件。更多...

(FSPDFObject *)	- getDefaultValueObj
	获取字段默认值的PDF对象。更多...

(FSPDFDictionary *)	- getDict
	获取当前对象的PDF字典。更多...

(FSPDFObject *)	- getInheritedAttribute:
	获取指定属性的PDF对象，该属性可能从字段树中的祖先节点继承。更多...

(NSString *)	- getName
	获取字段名称。更多...

(FSFieldType)	- getType
	获取字段类型。更多...

(FSPDFObject *)	- getValueObj
	获取字段值的PDF对象。更多...

(id)	- initWithDocument:field_dict:
	从字段字典构造函数。更多...

(id)	- initWithField:
	构造函数，使用另一个表单字段对象。更多...

(BOOL)	- isEmpty
	检查当前对象是否为空。更多...

(BOOL)	- reset
	将当前字段中的数据重置为其默认值。（不支持签名字段）更多...

属性
FSAlignment	alignment
	获取对齐值。更多...

NSString *	alternateName
	获取备用名称。更多...

FSDefaultAppearance *	defaultAppearance
	获取默认外观数据。

NSString *	defaultValue
	获取默认值。更多...

unsigned int	flags
	获取字段标志。更多...

NSString *	mappingName
	获取映射名称。更多...

int	maxLength
	获取字段文本的最大长度（以字符为单位）。更多...

FSChoiceOptionArray *	options
	获取列表框或组合框的选项。更多...

int	topVisibleIndex
	获取可滚动列表框的选项顶部索引。更多...

NSString *	value
	获取值。更多...

详细描述

在PDF文档中，表单字段出现在页面的任何组合上，所有这些字段组成一个跨越整个文档的单一全局交互式表单。函数 FSForm::getField:filter: 可用于从交互式表单获取表单字段。此类提供了获取表单字段一些信息/属性、将表单字段重置为其默认值以及从表单字段获取表单控件的函数。
当表单字段的类型为 FSFieldTypeSignature 时，表单字段对象实际上是一个签名对象。
要访问附加操作，请使用Field对象构造 FSAdditionalAction 对象。

参见: FSForm; FSSignature; FSAdditionalAction

函数文档

◆ getControl:()

- (FSControl *) getControl: (int) index

通过索引获取表单控件。

参数

[in] index 表单控件索引。有效范围：从0到(count-1)。 count由函数 FSField::getControlCount 返回。

返回: 表单控件对象。

◆ getControlCount()

- (int) getControlCount

获取表单控件数量。

返回: 表单控件的数量。

◆ getControlCountWithPDFPage:()

- (int) getControlCountWithPDFPage: (FSPDFPage*) page

获取指定PDF页面中的表单控件数量。

参数

[in] page 有效的PDF页面对象。它应该与当前表单字段在同一文档中。

返回: 指定PDF页面中表单控件的数量。

◆ getControlWithPDFPage:index:()

- (FSControl *) getControlWithPDFPage:	(FSPDFPage*)	page
index:	(int)	index

在指定PDF页面中通过索引获取表单控件。

参数

[in]	page	有效的PDF页面对象。它应该与当前表单字段在同一文档中。
[in]	index	表单控件索引。有效范围：从0到(count-1)。 count由函数 FSField::getControlCount 使用相同参数page返回。

返回: 表单控件对象。

◆ getDefaultValueObj()

- (FSPDFObject *) getDefaultValueObj

获取字段默认值的PDF对象。

字段默认值的格式因字段类型而异。有关更多详细信息，请参考《PDF参考1.7》P676中的"表8.69 所有字段字典的通用条目"。

返回: PDF对象。如果没有"DV"条目或发生任何错误，此函数将返回nil。

◆ getDict()

- (FSPDFDictionary *) getDict

获取当前对象的PDF字典。

返回: 当前对象的PDF字典。如果有任何错误，函数将返回nil。

◆ getInheritedAttribute:()

- (FSPDFObject *) getInheritedAttribute: (NSString *) attribute_name

获取指定属性的PDF对象，该属性可能从字段树中的祖先节点继承。

某些字段属性被指定为可继承的，例如"Ff"、"V"、"DV"等。请参考《PDF参考1.7》P675中的"表8.69 所有字段字典的通用条目"。如果没有由attribute_name指定的条目或发生任何错误，此函数将返回nil。

参数

[in] attribute_name 要查找的属性名称。

返回: PDF对象。如果未找到，此函数将返回nil。

◆ getName()

- (NSString *) getName

获取字段名称。

返回: 字段名称字符串。

◆ getType()

- (FSFieldType) getType

获取字段类型。

返回: 表单字段类型。请参考从 FSFieldTypeUnknown 开始的值，这将是其中一个值。

◆ getValueObj()

- (FSPDFObject *) getValueObj

获取字段值的PDF对象。

字段值的格式因字段类型而异。有关更多详细信息，请参考《PDF参考1.7》P676中的"表8.69 所有字段字典的通用条目"。

返回: PDF对象。如果没有"V"条目或发生任何错误，此函数将返回nil。

◆ initWithDocument:field_dict:()

- (id) initWithDocument:	(FSPDFDoc*)	document
field_dict:	(FSPDFDictionary*)	field_dict

从字段字典构造函数。

参数

[in]	document	一个有效的PDF文档。
[in]	field_dict	表示表单字段的PDF字典。它应该属于参数document指定的PDF文档。

◆ initWithField:()

- (id) initWithField: (FSField*) field

构造函数，使用另一个表单字段对象。

参数

[in] field 另一个表单字段对象。

被 FSSignature 重载.

◆ isEmpty()

- (BOOL) isEmpty

检查当前对象是否为空。

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

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

被 FSSignature 重载.

◆ reset()

- (BOOL) reset

将当前字段中的数据重置为其默认值。（不支持签名字段）

返回: YES 表示成功，NO 表示当前表单字段是签名字段或失败。

属性说明

◆ alignment

- (FSAlignment) alignment

readwritenonatomicassign

获取对齐值。

对齐是可变文本的属性，仅对文本字段、列表框和组合框有用，这些字段可能包含可变文本作为其内容。
如果文本字段或列表框有自己的对齐值，则将忽略文档范围的默认对齐值；否则，将为文本字段或列表框使用文档范围的默认对齐值。

◆ alternateName

- (NSString *) alternateName

readwritenonatomicweak

获取备用名称。

备用字段名称用于在用户界面中必须标识字段的任何地方（例如在引用字段的错误或状态消息中）代替实际字段名称。此文本在提取文档内容以支持残障用户的可访问性或其他目的时也很有用。

◆ defaultValue

- (NSString *) defaultValue

readwritenonatomicweak

获取默认值。

适用于除按钮以外的所有字段。

◆ flags

- (unsigned int) flags

readwritenonatomicassign

获取字段标志。

字段标志指定表单字段的各种特征。

◆ mappingName

- (NSString *) mappingName

readwritenonatomicweak

获取映射名称。

映射名称用于从文档导出交互式表单字段数据时使用。

◆ maxLength

- (int) maxLength

readwritenonatomicassign

获取字段文本的最大长度（以字符为单位）。

适用于文本字段。对于不适用的字段类型，此函数将返回0。

◆ options

- (FSChoiceOptionArray *) options

readwritenonatomicweak

获取列表框或组合框的选项。

适用于列表框和组合框。对于不适用的字段类型，此函数将返回空数组。

◆ topVisibleIndex

- (int) topVisibleIndex

readwritenonatomicassign

获取可滚动列表框的选项顶部索引。

适用于列表框。对于不适用的字段类型，此函数将返回0。
选项的顶部索引是列表中第一个可见选项的索引。

◆ value

- (NSString *) value

readwritenonatomicweak

获取值。

适用于除按钮以外的所有字段。对于不适用的字段类型，将返回空字符串。对于复选框和单选框，此函数将返回外观状态值。