跳转到主要内容
提供对 Field、其值和参数的访问。可以使用脚本修改 Field 的值。脚本还可用于添加建议值,以供人工校验人员查看。

属性

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

方法

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