Field provides access to a document field — its value, parameters, and structure. From a script, you can modify a field’s value or add suggested values that are shown to manual review operators.
Properties
Children
Type:Field[] — Access: Read-only
The child field array. Valid only for group fields.
DataType
Type: DataType — Access: Read-only The type of data in the field.FieldType
Type: FieldType — Access: Read-only The type of field — for example, text, checkmark, or a table (containing cells that represent other fields).FullName
Type:string — Access: Read-only
The full path to the field from the document root. Uses a forward slash (/) as a separator — for example, Vendor/Address/Street.
HasRegion
Type:bool — Access: Read-write
true if the field has been found on the document (a region exists for it on the image). false means no corresponding region was found.
HasSuspiciousSymbols
Type:bool — Access: Read-only
true if the field value contains characters recognized with low confidence.
Id
Type:string — Access: Read-only
The field identifier, unique within the document.
ImageRegions
Type: ImageRegionList — Access: Read-write An array of field regions on the image.InstanceIndex
Type:int — Access: Read-only
The index of the current instance of a repeating field. Set to -1 for non-repeating fields.
Instances
Type:Field[] — Access: Read-only
The array of all instances of this field (repeating fields only). Use Instances to access repeating field instances in a container obtained via GetField.
IsConfirmed
Type:bool — Access: Read-write
true if the field has been verified by an operator or by a validation rule.
IsRepeatable
Type:bool — Access: Read-only
true if the field is a repeating field.
IsSuspicious
Type:bool — Access: Read-only
true if any characters in the field value were recognized with low confidence. Such fields should be reviewed manually or checked by a rule.
IsValid
Type:bool — Access: Read-only
true if the recognized text in Text was successfully converted into a value of the specified type in Value.
IsVisible
Type:bool — Access: Read-only
true if the field is visible on the document.
Name
Type:string — Access: Read-only
The field name, unique within its group.
Parent
Type:Field — Access: Read-only
The parent field.
ReadOnly
Type:bool — Access: Read-only
true if the field is read-only and cannot be edited during manual review.
Symbols
Type: Symbol[] — Access: Read-only
An array of characters that form the original value of the field in text format.
Text
Type:string — Access: Read-only
The original value of the field in text format (generated when the document is recognized).
Value
Type:object — Access: Read-write
The value of the field in the specified format (generated when converting recognized text).
Unlike
Text, the Value property stores the normalized value. If a script modifies Value to a different normalized value, Text is updated with the new normalized form. If Value is unchanged after the script runs, Text is not updated.Methods
AddSuggestion
Not supported on field groups or repeating field containers.
CopyTo
Text, Value, ImageRegions, and Symbols from the argument field to the current field. Returns an error if the two fields have different data types.
GetChild
GetChild to access elements within a list — for example, different cells in the same row.