Passer au contenu principal

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

Propriétés

NomTypeAccèsDescription
ChildrenField[]Lecture seuleChamps enfants.
DataTypeDataTypeLecture seuleLe type de données du champ.
FieldTypeFieldOcrTypeLecture seuleLe type du champ (par exemple, texte, Barcode ou image).
FullNamestringLecture seuleLe chemin complet depuis la racine du document. Les noms des champs parents sont séparés par / — par exemple, Vendor/Address.
IdstringLecture seuleL’identifiant d’une définition de champ dans la définition du document.
InstanceIdstringLecture seuleL’identifiant d’une instance de champ. Si le document ne comporte aucune instance du champ, InstanceId vaut null.
InstanceIndexnumberLecture seuleL’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.
InstancesField[]Lecture seuleToutes les instances de ce champ. N’a de sens que pour les champs répétitifs.
IsConfirmedbooleanLecture seuletrue si la valeur a été confirmée par un opérateur lors de la vérification.
IsRepeatablebooleanLecture seuletrue si le champ est répétitif.
IsSuspiciousbooleanLecture seuletrue si la reconnaissance n’était pas suffisamment fiable pour ce champ.
IsValidbooleanLecture seuletrue si Text a été converti avec succès en Value du type correct ; sinon false.
IsVisiblebooleanLecture seuletrue si le champ est visible par les opérateurs ; false s’il est masqué pendant la vérification.
NamestringLecture seuleLe nom du champ.
ParentFieldLecture seuleLe champ parent.
RegionsRegionsCollectionLecture seuleLes régions de l’image où se trouve le champ.
TextstringLecture seuleLe texte du champ tel qu’il a été détecté dans le document.
ValueobjectLecture/écritureLa valeur du champ convertie dans le type de données approprié (par exemple, date ou nombre à virgule flottante).
ImageBinaryFileLecture seuleL’image au format binaire.
Image s’applique uniquement aux champs de type Picture.

Méthodes

AddInstance

Field AddInstance(any value?);
Crée ou met à jour une instance de champ, selon le type de champ :
  • 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.

Supprimer

void Remove();
Supprime le champ.

Document

Le document en cours de traitement par l’activité personnalisée.

DataType

Les types de données qu’un champ peut contenir.

FieldOcrType

Indique le type OCR du champ extrait.

Region

Zone d’une image de la page contenant le texte d’un champ.

BinaryFile

Données d’un fichier au format binaire — généralement l’image source avant le prétraitement.

Modèle objet

Référence complète du modèle objet JavaScript pour les scripts de l’activité personnalisée.