Skip to main content

​
Properties

NameTypeDescription
ChildrenField[], read-onlyChild fields.
DataTypeDataType, read-onlyThe field data type.
FieldTypeFieldOcrType, read-onlyThe field type (such as text, barcode, or image).
FullNamestring, read-onlyThe full root path to the document. The parent field names are separated by the ”/” symbol. For example, the address field for a vendor company may be called “Vendor/Address”.
Idstring, read-onlyThe identifier of a field definition from the document definition.
InstanceIdstring, read-onlyThe identifier of a field instance. A document may have no instances of a field, in this case InstanceId = null.
InstanceIndexnumber, read-onlyThe index number of the current field instance among all repeating fields of the same type. This property only applies to repeating fields.
InstancesField[], read-onlyAll instances of this field type. This property only applies to repeating fields.
IsConfirmedboolean, read-onlyReturns true if the value was confirmed by an operator during verification.
IsRepeatableboolean, read-onlyReturns true if it is a repeating field.
IsSuspiciousboolean, read-onlyReturns true if the algorithm is not certain about the recognition results for the field.
IsValidboolean, read-onlyReturns true if the field text (Text) was successfully converted to a value of the correct type (Value). Returns false otherwise.
IsVisibleboolean, read-onlyReturns true if the field can be viewed by an operator. If the field was hidden during verification, returns false.
Namestring, read-onlyThe field name.
ParentField, read-onlyThe parent field.
RegionsRegionsCollection, read-onlyRegions on the image where the field is located.
Textstring, read-onlyThe field text as detected on the document.
ValueobjectThe value of the field once converted to the appropriate data type, e.g. date or float.
ImageBinaryFile, read-onlyThe image in binary format. Only applies to fields of type Picture.

​
Methods

NameDescription
AddInstance(any value?);For non-repeating fields: Updates the value of an existing field instance, or creates a field instance if it didn’t exist. For repeating fields: Creates a new field instance. Returns the Field object that was created or updated.
Remove();Deletes the field.