Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt

Use this file to discover all available pages before exploring further.

Field provides access to a document field’s value, type, structure, and OCR metadata in a Custom activity script.

​
Properties

NameTypeAccessDescription
ChildrenField[]Read-onlyChild fields.
DataTypeDataTypeRead-onlyThe field data type.
FieldTypeFieldOcrTypeRead-onlyThe field type (for example, text, barcode, or image).
FullNamestringRead-onlyThe full path from the document root. Parent field names are separated by / — for example, Vendor/Address.
IdstringRead-onlyThe identifier of a field definition from the document definition.
InstanceIdstringRead-onlyThe identifier of a field instance. If the document has no instances of the field, InstanceId is null.
InstanceIndexnumberRead-onlyThe index of the current instance among all repeating fields of the same type. Only meaningful for repeating fields.
InstancesField[]Read-onlyAll instances of this field. Only meaningful for repeating fields.
IsConfirmedbooleanRead-onlytrue if the value was confirmed by an operator during verification.
IsRepeatablebooleanRead-onlytrue if the field is repeating.
IsSuspiciousbooleanRead-onlytrue if recognition wasn’t confident for this field.
IsValidbooleanRead-onlytrue if Text converted successfully to a Value of the correct type; otherwise false.
IsVisiblebooleanRead-onlytrue if the field is visible to operators; false if hidden during verification.
NamestringRead-onlyThe field name.
ParentFieldRead-onlyThe parent field.
RegionsRegionsCollectionRead-onlyRegions on the image where the field is located.
TextstringRead-onlyThe field text as detected on the document.
ValueobjectRead-writeThe field value converted to the appropriate data type (for example, date or float).
ImageBinaryFileRead-onlyThe image in binary format.
Image only applies to fields of type Picture.

​
Methods

​
AddInstance

Field AddInstance(any value?);
Creates or updates a field instance, depending on the field type:
  • Non-repeating fields — Updates the existing instance, or creates one if none exists.
  • Repeating fields — Creates a new instance.
Returns the created or updated Field object.

​
Remove

void Remove();
Deletes the field.

Document

The document currently being processed by the Custom activity.

DataType

The possible data types a field can contain.

FieldOcrType

Specifies the OCR type of the extracted field.

Region

Area on a page image that contains the text for a field.

BinaryFile

File data in binary format — typically the pre-preprocessing source image.

Object model

Full JavaScript object reference for Custom activity scripts.