Skip to main content
Provides access to a field, its value and parameters. A field’s value can be modified using a script. Scripts can also be used to add suggested values to be displayed to manual review operators.

​
Properties

NameTypeAccess LevelDescription
ChildrenField[]Read-onlyThe child field array. This property is only valid for group fields.
DataTypeDataTypeRead-onlyThe type of data in the field.
FieldTypeFieldTypeRead-onlyThe type of the field, for example text, checkmark, a table (contains cells that represent other fields).
FullNamestringRead-onlyThe full path to the name from the document root. Uses a forward slash (/) as a separator, e.g. Vendor/Address/Street.
HasRegionboolRead-writeReturns true if the field has been found on the document, i.e. a corresponding region exists on the document. A value of false specifies that the image of the document does not contain a region that corresponds to this field.
HasSuspiciousSymbolsboolRead-onlyReturns true if the field value contains characters recognized with low confidence.
IdstringRead-onlyThe field identifier, unique in the document.
ImageRegionsImageRegionListRead-writeAn array of field regions on the image.
InstanceIndexintRead-onlyThe index of the current instance of the repeating field. Only makes sense if IsRepeatable is true. Set to -1 in all other cases.
InstancesField[]Read-onlyThe array of all instances of this field. Only makes sense if IsRepeatable is true. The Instances property can be used to access repeating field instances in a container obtained using the Field GetField method.
IsConfirmedboolRead-writeReturns true if the field has been verified by the operator or by a validation rule.
IsRepeatableboolRead-onlyReturns true if the field is repeating.
IsSuspiciousboolRead-onlyReturns true if any characters of the field value have been recognized with low confidence. The value of such a field should either be reviewed manually by an operator or checked by a rule.
IsValidboolRead-onlyReturns true if the recognized text of the field - stored the Text property - was successfully converted into the value of the specified type in the Value property.
IsVisibleboolRead-onlyReturns true if the field is visible on the document.
NamestringRead-onlyThe field name, unique inside its group.
ParentFieldRead-onlyThe parent field.
ReadOnlyboolRead-onlyReturns true if the field is read-only and may not be edited by the manual review operator.
SymbolsSymbol[]Read-onlyAn array of characters that form the original value of the field in text format.
TextstringRead-onlyThe original value of the field in text format (generated when a document is recognized).
ValueobjectRead-writeThe value of the field in the specified format (generated when converting recognized text). Note: Unlike the Text property, the Value property stores values in a normalized format. If the normalized value of the Value property is modified as a result of running a script, the value of the Text property will be updated with the new normalized value. If the normalized value of the Value property remains unmodified after running the script, the value of the Text property will not be updated.

​
Methods

NameDescription
void AddSuggestion(string value);Adds a suggested value for the field. This method allows a user to choose the value from the list of suggested values. The suggested values will be displayed during manual review. This method cannot be applied to field groups and repeating field containers.
void CopyTo(Field field);Copies the following properties of the argument field to the current field: Text, Value, ImageRegions, Symbols. If the field and field data types are not identical, the method returns an error.
Field GetChild(string fieldName);Returns a child field with the specified name. This method makes it easier to access different elements of the same list, e.g. different cells in the same row. Important! Pass the string name of the field to this method directly: a variable with the same string value won’t work. The preprocessor that parses the script code before executing it will replace the name of the field with its identifier, but won’t be able to process a variable.