Field

The Field interface provides access to the field value and its properties.

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

Properties

Name	Type	Access	Description
Children	Field[]	Read-only	Child fields.
DataType	DataType	Read-only	The field data type.
FieldType	FieldOcrType	Read-only	The field type (for example, text, barcode, or image).
FullName	string	Read-only	The full path from the document root. Parent field names are separated by / — for example, Vendor/Address.
Id	string	Read-only	The identifier of a field definition from the document definition.
InstanceId	string	Read-only	The identifier of a field instance. If the document has no instances of the field, InstanceId is null.
InstanceIndex	number	Read-only	The index of the current instance among all repeating fields of the same type. Only meaningful for repeating fields.
Instances	Field[]	Read-only	All instances of this field. Only meaningful for repeating fields.
IsConfirmed	boolean	Read-only	true if the value was confirmed by an operator during verification.
IsRepeatable	boolean	Read-only	true if the field is repeating.
IsSuspicious	boolean	Read-only	true if recognition wasn’t confident for this field.
IsValid	boolean	Read-only	true if Text converted successfully to a Value of the correct type; otherwise false.
IsVisible	boolean	Read-only	true if the field is visible to operators; false if hidden during verification.
Name	string	Read-only	The field name.
Parent	Field	Read-only	The parent field.
Regions	RegionsCollection	Read-only	Regions on the image where the field is located.
Text	string	Read-only	The field text as detected on the document.
Value	object	Read-write	The field value converted to the appropriate data type (for example, date or float).
Image	BinaryFile	Read-only	The 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.

Related topics

• Document
• DataType
• FieldOcrType
• Region
• BinaryFile
• Object model