跳转到主要内容
提供对字段及其值和参数的只读访问。

属性

名称类型访问级别描述
ChildrenField[]只读 (Read-only)子字段数组。此属性仅对包含重复字段的容器有效。
DataTypeDataType只读 (Read-only)字段中的数据类型。
FieldTypeFieldType只读 (Read-only)字段的类型。
FullNamestring只读 (Read-only)从文档根节点到该字段名称的完整路径。使用正斜杠 (/) 作为分隔符,例如 Vendor/Address/Street
HasRegionbool只读 (Read-only)如果在文档中找到了该字段(即文档中存在相应区域),则返回 true。值为 false 表示文档图像中不包含与此字段对应的区域。
Idstring只读 (Read-only)来自文档定义的字段标识符。
ImageRegionsImageRegionList只读 (Read-only)字段在图像中的区域数组。
InstanceIndexint只读 (Read-only)重复字段当前实例的索引。仅当 IsRepeatabletrue 时才有意义。其他情况下设置为 -1。
InstancesField[]只读 (Read-only)此字段所有实例的数组。仅当 IsRepeatabletrue 时才有意义。
IsConfirmedbool只读 (Read-only)如果字段已由操作员或验证规则确认,则返回 true
IsRepeatablebool只读 (Read-only)如果字段是可重复的,则返回 true
IsSuspiciousbool只读 (Read-only)如果字段值中的任意字符识别结果不可靠,则返回 true。此类字段的值应由操作员进行人工审核,或通过规则进行检查。
IsValidbool只读 (Read-only)如果字段的已识别文本(Text 属性)已成功转换为所需类型的值(Value 属性),则返回 true
IsVisiblebool只读 (Read-only)如果字段在文档中可见,则返回 true
Namestring只读 (Read-only)字段名称,在其所属组内唯一。
ParentField只读 (Read-only)父字段。
ReadOnlybool只读 (Read-only)如果字段为只读,且人工审核操作员不能编辑,则返回 true
SymbolsSymbol[]只读 (Read-only)构成字段原始文本值的字符数组。
Textstring只读 (Read-only)字段的原始文本格式值(在文档识别时生成)。
Valueobject只读 (Read-only)指定格式的字段值(在转换已识别文本时生成)。

方法

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