> ## 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 object — properties and methods for inspecting and modifying a document field during rule execution.

`Field` provides access to a document field — its value, parameters, and structure. From a script, you can modify a field's value or add suggested values that are shown to manual review operators.

## Properties

### Children

**Type:** `Field[]` — **Access:** Read-only

The child field array. Valid only for group fields.

### DataType

**Type:** [DataType](/vantage/documentation/skill-designer/document/rule-verification/data-type) — **Access:** Read-only

The type of data in the field.

### FieldType

**Type:** [FieldType](/vantage/documentation/skill-designer/document/rule-verification/field-type) — **Access:** Read-only

The type of field — for example, text, checkmark, or a table (containing cells that represent other fields).

### FullName

**Type:** `string` — **Access:** Read-only

The full path to the field from the document root. Uses a forward slash (`/`) as a separator — for example, `Vendor/Address/Street`.

### HasRegion

**Type:** `bool` — **Access:** Read-write

`true` if the field has been found on the document (a region exists for it on the image). `false` means no corresponding region was found.

### HasSuspiciousSymbols

**Type:** `bool` — **Access:** Read-only

`true` if the field value contains characters recognized with low confidence.

### Id

**Type:** `string` — **Access:** Read-only

The field identifier, unique within the document.

### ImageRegions

**Type:** [ImageRegionList](/vantage/documentation/skill-designer/document/rule-verification/image-region-list) — **Access:** Read-write

An array of field regions on the image.

### InstanceIndex

**Type:** `int` — **Access:** Read-only

The index of the current instance of a repeating field. Set to `-1` for non-repeating fields.

### Instances

**Type:** `Field[]` — **Access:** Read-only

The array of all instances of this field (repeating fields only). Use `Instances` to access repeating field instances in a container obtained via [`GetField`](/vantage/documentation/skill-designer/document/rule-verification/context#getfield).

### IsConfirmed

**Type:** `bool` — **Access:** Read-write

`true` if the field has been verified by an operator or by a validation rule.

### IsRepeatable

**Type:** `bool` — **Access:** Read-only

`true` if the field is a repeating field.

### IsSuspicious

**Type:** `bool` — **Access:** Read-only

`true` if any characters in the field value were recognized with low confidence. Such fields should be reviewed manually or checked by a rule.

### IsValid

**Type:** `bool` — **Access:** Read-only

`true` if the recognized text in `Text` was successfully converted into a value of the specified type in `Value`.

### IsVisible

**Type:** `bool` — **Access:** Read-only

`true` if the field is visible on the document.

### Name

**Type:** `string` — **Access:** Read-only

The field name, unique within its group.

### Parent

**Type:** `Field` — **Access:** Read-only

The parent field.

### ReadOnly

**Type:** `bool` — **Access:** Read-only

`true` if the field is read-only and cannot be edited during manual review.

### Symbols

**Type:** [Symbol](/vantage/documentation/skill-designer/document/rule-verification/symbol)`[]` — **Access:** Read-only

An array of characters that form the original value of the field in text format.

### Text

**Type:** `string` — **Access:** Read-only

The original value of the field in text format (generated when the document is recognized).

### Value

**Type:** `object` — **Access:** Read-write

The value of the field in the specified format (generated when converting recognized text).

<Note>
  Unlike `Text`, the `Value` property stores the normalized value. If a script modifies `Value` to a different normalized value, `Text` is updated with the new normalized form. If `Value` is unchanged after the script runs, `Text` is not updated.
</Note>

## Methods

### AddSuggestion

```javascript theme={null}
void AddSuggestion(string value);
```

Adds a suggested value for the field. During manual review, operators can pick from the list of suggested values.

<Note>
  Not supported on field groups or repeating field containers.
</Note>

### CopyTo

```javascript theme={null}
void CopyTo(Field field);
```

Copies `Text`, `Value`, `ImageRegions`, and `Symbols` from the argument field to the current field. Returns an error if the two fields have different data types.

### GetChild

```javascript theme={null}
Field GetChild(string fieldName);
```

Returns the child field with the specified name. Use `GetChild` to access elements within a list — for example, different cells in the same row.

<Warning>
  Pass the field name as a string literal, not a variable. The script preprocessor replaces the literal name with the field's identifier before execution — variables aren't processed.
</Warning>

## Related topics

<CardGroup cols={2}>
  <Card title="Object model" icon="diagram-project" href="/vantage/documentation/skill-designer/document/rule-verification/object-model">
    Full JavaScript object reference for use in Advanced Script Rules.
  </Card>

  <Card title="Context" icon="braces" href="/vantage/documentation/skill-designer/document/rule-verification/context">
    The Context global object — access the document, fields, and skill parameters from inside a rule.
  </Card>

  <Card title="FieldType" icon="list" href="/vantage/documentation/skill-designer/document/rule-verification/field-type">
    Enumeration of available field types and the data types each supports.
  </Card>

  <Card title="DataType" icon="list-check" href="/vantage/documentation/skill-designer/document/rule-verification/data-type">
    Enumeration of data types a field can contain (also includes `AmountOfMoney` for currency).
  </Card>
</CardGroup>