This interface is deprecated. It will provide access only to the first document of the transaction. The extracted field.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.
Properties
| Name | Type | Description |
|---|---|---|
| Name | string, read-only | The field name. ExtractedData fields are grouped, hence the field name should be passed as a path, for example, “Amounts/Additional Tax Groups/NetAmount”. Forward slashes are used as separators between fields and group names. |
| IsRepeatable | boolean, read-only | Specifies whether the field is repeating. |
| IsParentRepeatable | boolean, read-only | Specifies whether the parent field is repeating. |
| FieldType | FieldOcrType, read-only | The field type. |
| HasStringValue | boolean, read-only | Specifies that the field is of type “string”. |
| HasBooleanValue | boolean, read-only | Specifies that the field value is of type “boolean”. |
| EnumValue | string | The EnumValue value. |
| StringValue | string | The string value of the field. |
| BooleanValue | string | The boolean value of the field. |
Methods
| Name | Description |
|---|---|
| SetImageRegion(number pageNumber, string region); | Sets a region for a field on the selected page. Region coordinates are specified in “left, top, right, bottom” format. If the page with the specified number does not exist in the document, an exception containing an error is generated. |
| GetImageRegion(number pageNumber); | Returns a string that contains field region coordinates on the selected page. Region coordinates are specified in “left, top, right, bottom” format. If the page with the specified number does not exist in the document, an exception containing an error is generated. If field coordinates are not specified, returns Null. |
| Remove(); | Deletes current field. |
Related topics
Field
Modern replacement — inspect and modify a document field during rule execution.
FieldOcrType
Enumeration of the possible field types.
ExtractedData
The deprecated container interface this field belongs to.
Object model
Full JavaScript object reference for Custom activity scripts.