跳转到主要内容

属性

名称类型描述
ChildrenField[],唯讀子 Field。
DataTypeDataType,唯讀Field 的数据类型。
FieldTypeFieldOcrType,唯讀Field 的类型(例如文本、条码或图像)。
FullNamestring,唯讀指向文档的完整根路径。父级 Field 名称以“/”分隔。例如,供应商公司的地址 Field 可能为“Vendor/Address”。
Idstring,唯讀来自文档定义的 Field 定义标识符。
InstanceIdstring,唯讀Field 实例的标识符。文档可能没有该 Field 的实例,此情况下 InstanceId = null
InstanceIndexnumber,唯讀在所有相同类型的重复 Field 中,当前 Field 实例的索引号。此属性仅适用于可重复的 Field。
InstancesField[],唯讀此 Field 类型的所有实例。此属性仅适用于可重复的 Field。
IsConfirmedboolean,唯讀若值在校验期间由操作员确认,则返回 true
IsRepeatableboolean,唯讀若为可重复的 Field,则返回 true
IsSuspiciousboolean,唯讀若算法对该 Field 的识别结果不确定,则返回 true
IsValidboolean,唯讀若 Field 文本(Text)已成功转换为正确类型的值(Value),则返回 true;否则返回 false
IsVisibleboolean,唯讀若该 Field 可供操作员查看,则返回 true;若该 Field 在校验期间被隐藏,则返回 false
Namestring,唯讀Field 名称。
ParentField,唯讀父级 Field。
RegionsRegionsCollection,唯讀图像中该 Field 所在的区域。
Textstring,唯讀在文档上检测到的 Field 文本。
Valueobject将 Field 文本转换为相应数据类型后的值,例如日期或浮点数。
ImageBinaryFile,唯讀二进制格式的图像。仅适用于 Picture 类型的 Field。

方法

名称描述
AddInstance(any value?);对于非重复 field:更新现有 field 实例的值,或在不存在时创建一个 field 实例。对于可重复 field:创建一个新的 field 实例。返回创建或更新的 Field 对象。
Remove();删除该 field。