Field permet d’accéder à la valeur, au type, à la structure et aux métadonnées OCR d’un champ d’un document dans un script d’activité personnalisée.
| Nom | Type | Accès | Description |
|---|
| Children | Field[] | Lecture seule | Champs enfants. |
| DataType | DataType | Lecture seule | Le type de données du champ. |
| FieldType | FieldOcrType | Lecture seule | Le type du champ (par exemple, texte, Barcode ou image). |
| FullName | string | Lecture seule | Le chemin complet depuis la racine du document. Les noms des champs parents sont séparés par / — par exemple, Vendor/Address. |
| Id | string | Lecture seule | L’identifiant d’une définition de champ dans la définition du document. |
| InstanceId | string | Lecture seule | L’identifiant d’une instance de champ. Si le document ne comporte aucune instance du champ, InstanceId vaut null. |
| InstanceIndex | number | Lecture seule | L’indice de l’instance actuelle parmi tous les champs répétitifs du même type. N’a de sens que pour les champs répétitifs. |
| Instances | Field[] | Lecture seule | Toutes les instances de ce champ. N’a de sens que pour les champs répétitifs. |
| IsConfirmed | boolean | Lecture seule | true si la valeur a été confirmée par un opérateur lors de la vérification. |
| IsRepeatable | boolean | Lecture seule | true si le champ est répétitif. |
| IsSuspicious | boolean | Lecture seule | true si la reconnaissance n’était pas suffisamment fiable pour ce champ. |
| IsValid | boolean | Lecture seule | true si Text a été converti avec succès en Value du type correct ; sinon false. |
| IsVisible | boolean | Lecture seule | true si le champ est visible par les opérateurs ; false s’il est masqué pendant la vérification. |
| Name | string | Lecture seule | Le nom du champ. |
| Parent | Field | Lecture seule | Le champ parent. |
| Regions | RegionsCollection | Lecture seule | Les régions de l’image où se trouve le champ. |
| Text | string | Lecture seule | Le texte du champ tel qu’il a été détecté dans le document. |
| Value | object | Lecture/écriture | La valeur du champ convertie dans le type de données approprié (par exemple, date ou nombre à virgule flottante). |
| Image | BinaryFile | Lecture seule | L’image au format binaire. |
Image s’applique uniquement aux champs de type Picture.
Field AddInstance(any value?);
- Champs non répétitifs — Met à jour l’instance existante, ou en crée une si aucune n’existe.
- Champs répétitifs — Crée une nouvelle instance.
Renvoie l’objet Field créé ou mis à jour.
Supprime le champ.
