跳转到主要内容
提供对字段、其值及其参数的访问。可以使用脚本修改字段的值。脚本还可用于添加候选值,这些值将显示给人工审核人员。

属性

名称类型访问级别描述
ChildrenField[]只读子字段数组。此属性仅对分组字段有效。
DataTypeDataType只读字段中的数据类型。
FieldTypeFieldType只读字段类型,例如文本、复选标记、表格(包含表示其他字段的单元格)。
FullNamestring只读从文档根节点开始到名称的完整路径。使用正斜杠 (/) 作为分隔符,例如 Vendor/Address/Street。
HasRegionbool读写如果在文档中找到了该字段(即文档上存在对应区域),则返回 true。值为 false 表示文档图像不包含与此字段对应的区域。
HasSuspiciousSymbolsbool只读如果字段值包含以低置信度识别的字符,则返回 true
Idstring只读字段标识符,在文档中唯一。
ImageRegionsImageRegionList读写图像上字段区域的数组。
InstanceIndexint只读重复字段当前实例的索引。仅当 IsRepeatabletrue 时才有意义。在所有其他情况下设置为 -1。
InstancesField[]只读此字段所有实例的数组。仅当 IsRepeatabletrue 时才有意义。Instances 属性可用于在使用 Field GetField 方法获取的容器中访问重复字段实例。
IsConfirmedbool读写如果字段已被操作员或验证规则确认,则返回 true
IsRepeatablebool只读如果字段是可重复的,则返回 true
IsSuspiciousbool只读如果字段值中的任意字符是以低置信度识别的,则返回 true。此类字段的值应由操作员进行人工审核,或由规则进行检查。
IsValidbool只读如果字段的已识别文本(存储在 Text 属性中)已成功转换为 Value 属性中指定类型的值,则返回 true
IsVisiblebool只读如果字段在文档中可见,则返回 true
Namestring只读字段名称,在其所属组内唯一。
ParentField只读父字段。
ReadOnlybool只读如果字段为只读且人工审核操作员不能编辑,则返回 true
SymbolsSymbol[]只读构成字段原始文本值的字符数组。
Textstring只读字段的原始文本格式值(在文档被识别时生成)。
Valueobject读写字段在指定格式中的值(在转换已识别文本时生成)。**注意:**与 Text 属性不同,Value 属性以规范化格式存储值。如果在运行脚本后,由于脚本执行导致 Value 属性的规范化值被修改,则 Text 属性的值会更新为新的规范化值。如果在运行脚本后 Value 属性的规范化值未被修改,则 Text 属性的值不会更新。

方法

NameDescription
void AddSuggestion(string value);为字段添加一个建议值。此方法允许用户从建议值列表中选择值。建议值将在人工审核期间显示。此方法不能用于字段组和重复字段容器。
void CopyTo(Field field);将参数字段的以下属性复制到当前字段:TextValueImageRegionsSymbols。如果字段及其数据类型不完全相同,则该方法会返回错误。
Field GetChild(string fieldName);返回具有指定名称的子字段。此方法便于访问同一列表中的不同元素,例如同一行中的不同单元格。重要! 将字段的字符串名称直接传递给此方法:具有相同字符串值的变量将不起作用。执行前解析脚本代码的预处理器会将字段名称替换为其标识符,但无法处理变量。