> ## 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

> 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](/vantage/documentation/skill-designer/process/custom-activity/data-type)                  | Read-only  | The field data type.                                                                                                 |
| **FieldType**     | [FieldOcrType](/vantage/documentation/skill-designer/process/custom-activity/field-ocr-type)         | 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](/vantage/documentation/skill-designer/process/custom-activity/region#collection) | 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](/vantage/documentation/skill-designer/process/custom-activity/binary-file)              | Read-only  | The image in binary format.                                                                                          |

<Note>
  `Image` only applies to fields of type **Picture**.
</Note>

## Methods

### AddInstance

```javascript theme={null}
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

```javascript theme={null}
void Remove();
```

Deletes the field.

## Related topics

<CardGroup cols={3}>
  <Card title="Document" icon="file-lines" href="/vantage/documentation/skill-designer/process/custom-activity/document">
    The document currently being processed by the Custom activity.
  </Card>

  <Card title="DataType" icon="list-check" href="/vantage/documentation/skill-designer/process/custom-activity/data-type">
    The possible data types a field can contain.
  </Card>

  <Card title="FieldOcrType" icon="list" href="/vantage/documentation/skill-designer/process/custom-activity/field-ocr-type">
    Specifies the OCR type of the extracted field.
  </Card>

  <Card title="Region" icon="vector-square" href="/vantage/documentation/skill-designer/process/custom-activity/region">
    Area on a page image that contains the text for a field.
  </Card>

  <Card title="BinaryFile" icon="file-binary" href="/vantage/documentation/skill-designer/process/custom-activity/binary-file">
    File data in binary format — typically the pre-preprocessing source image.
  </Card>

  <Card title="Object model" icon="diagram-project" href="/vantage/documentation/skill-designer/process/custom-activity/object-model">
    Full JavaScript object reference for Custom activity scripts.
  </Card>
</CardGroup>
