跳转到主要内容
提供对 field、其值和 Parameter 的唯讀访问。

属性

NameTypeAccess LevelDescription
ChildrenField[]Read-only子 field 数组。此属性仅对包含可重复 field 的容器有效。
DataTypeDataTypeRead-onlyfield 中数据的类型。
FieldTypeFieldTypeRead-onlyfield 的类型。
FullNamestringRead-only从文档根开始的名称完整路径。使用正斜杠 (/) 作为分隔符,例如 Vendor/Address/Street
HasRegionboolRead-only如果在文档上找到了该 field(即文档上存在相应的区域)则返回 true。值为 false 表示文档图像不包含与此 field 对应的区域。
IdstringRead-only文档定义中的 field 标识符。
ImageRegionsImageRegionListRead-only图像上的 field 区域数组。
InstanceIndexintRead-only可重复 field 的当前实例索引。仅当 IsRepeatabletrue 时有意义。其他情况下为 -1。
InstancesField[]Read-only此 field 的所有实例数组。仅当 IsRepeatabletrue 时有意义。
IsConfirmedboolRead-only如果该 field 已由操作员或验证规则确认,则返回 true
IsRepeatableboolRead-only如果该 field 是可重复的,则返回 true
IsSuspiciousboolRead-only如果 field 值中的任意字符识别不可靠,则返回 true。此类 field 的值应由操作员进行人工校验或通过规则检查。
IsValidboolRead-only如果 field 的识别文本(Text 属性)已成功转换为所需类型的值(Value 属性),则返回 true
IsVisibleboolRead-only如果该 field 在文档上可见,则返回 true
NamestringRead-onlyfield 名称,在其所属组内唯一。
ParentFieldRead-only父 field。
ReadOnlyboolRead-only如果该 field 为唯讀,且人工校验操作员不得编辑,则返回 true
SymbolsSymbol[]Read-only构成 field 原始文本值的字符数组。
TextstringRead-onlyfield 的原始文本值(在识别文档时生成)。
ValueobjectRead-only按指定格式表示的 field 值(在将识别文本转换后生成)。

方法

名称说明
Field GetChild(string fieldDefinitionId);返回具有指定标识符的子字段。