Field - ABBYY Documentation

Provides read-only access to a field, its value and parameters.

Properties

Name	Type	Access Level	Description
`Children`	`Field[]`	Read-only	The child field array. This property is only valid for containers of repeating fields.
`DataType`	`DataType`	Read-only	The type of data in the field.
`FieldType`	`FieldType`	Read-only	The type of the field.
`FullName`	`string`	Read-only	The full path to the name from the document root. Uses a forward slash (/) as a separator, e.g. `Vendor/Address/Street`.
`HasRegion`	`bool`	Read-only	Returns `true` if the field has been found on the document, i.e. if 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.
`Id`	`string`	Read-only	The field identifier from the document definition.
`ImageRegions`	`ImageRegionList`	Read-only	An array of field regions on the image.
`InstanceIndex`	`int`	Read-only	The index of the current instance of the repeating field. Only makes sense if `IsRepeatable` is `true`. Set to -1 in all other cases.
`Instances`	`Field[]`	Read-only	The array of all instances of this field. Only makes sense if `IsRepeatable` is `true`.
`IsConfirmed`	`bool`	Read-only	Returns `true` if the field has been verified by the operator or by a validation rule.
`IsRepeatable`	`bool`	Read-only	Returns `true` if the field is repeating.
`IsSuspicious`	`bool`	Read-only	Returns `true` if any characters of the field value have been recognized unreliably. The value of such a field should either be reviewed manually by an operator or checked by a rule.
`IsValid`	`bool`	Read-only	Returns `true` if the recognized text of the field (the `Text` property) was successfully converted into the value of the necessary type (the `Value` property).
`IsVisible`	`bool`	Read-only	Returns `true` if the field is visible on the document.
`Name`	`string`	Read-only	The field name, unique inside its group.
`Parent`	`Field`	Read-only	The parent field.
`ReadOnly`	`bool`	Read-only	Returns `true` if the field is read-only and may not be edited by the manual review operator.
`Symbols`	`Symbol[]`	Read-only	An array of characters that form the original value of a field in text format.
`Text`	`string`	Read-only	The original value of a field in text format (generated when a document is recognized).
`Value`	`object`	Read-only	The value of a field in the specified format (generated when converting recognized text).

Methods

Name	Description
`Field GetChild(string fieldDefinitionId);`	Returns a child field with the specified identifier.

​Properties

​Methods

Properties

Methods