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

Properties

NameTypeAccess LevelDescription
ChildrenField[]Read-onlyThe child field array. This property is only valid for containers of repeating fields.
DataTypeDataTypeRead-onlyThe type of data in the field.
FieldTypeFieldTypeRead-onlyThe type of the field.
FullNamestringRead-onlyThe full path to the name from the document root. Uses a forward slash (/) as a separator, e.g. Vendor/Address/Street.
HasRegionboolRead-onlyReturns 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.
IdstringRead-onlyThe field identifier from the document definition.
ImageRegionsImageRegionListRead-onlyAn array of field regions on the image.
InstanceIndexintRead-onlyThe index of the current instance of the repeating field. Only makes sense if IsRepeatable is true. Set to -1 in all other cases.
InstancesField[]Read-onlyThe array of all instances of this field. Only makes sense if IsRepeatable is true.
IsConfirmedboolRead-onlyReturns true if the field has been verified by the operator or by a validation rule.
IsRepeatableboolRead-onlyReturns true if the field is repeating.
IsSuspiciousboolRead-onlyReturns 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.
IsValidboolRead-onlyReturns true if the recognized text of the field (the Text property) was successfully converted into the value of the necessary type (the Value property).
IsVisibleboolRead-onlyReturns true if the field is visible on the document.
NamestringRead-onlyThe field name, unique inside its group.
ParentFieldRead-onlyThe parent field.
ReadOnlyboolRead-onlyReturns true if the field is read-only and may not be edited by the manual review operator.
SymbolsSymbol[]Read-onlyAn array of characters that form the original value of a field in text format.
TextstringRead-onlyThe original value of a field in text format (generated when a document is recognized).
ValueobjectRead-onlyThe value of a field in the specified format (generated when converting recognized text).

Methods

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