Passer au contenu principal
Fournit l’accès à un champ, à sa valeur et à ses paramètres. La valeur d’un champ peut être modifiée au moyen d’un script. Les scripts peuvent également servir à proposer des valeurs suggérées à afficher aux opérateurs de relecture manuelle.

​
Propriétés

NameTypeAccess LevelDescription
ChildrenField[]Lecture seuleLe tableau des champs enfants. Cette propriété n’est valable que pour les champs de groupe.
DataTypeDataTypeLecture seuleLe type de données du champ.
FieldTypeFieldTypeLecture seuleLe type du champ, par exemple texte, case à cocher, tableau (contient des cellules représentant d’autres champs).
FullNamestringLecture seuleLe chemin complet vers le nom depuis la racine du document. Utilise une barre oblique (/) comme séparateur, p. ex. Vendor/Address/Street.
HasRegionboolLecture/écritureRenvoie true si le champ a été trouvé sur le document, c.-à-d. qu’une région correspondante existe sur le document. Une valeur false indique que l’image du document ne contient pas de région correspondant à ce champ.
HasSuspiciousSymbolsboolLecture seuleRenvoie true si la valeur du champ contient des caractères reconnus avec une faible confiance.
IdstringLecture seuleL’identifiant du champ, unique dans le document.
ImageRegionsImageRegionListLecture/écritureUn tableau des régions du champ sur l’image.
InstanceIndexintLecture seuleL’index de l’instance actuelle du champ répétable. N’a de sens que si IsRepeatable est true. Défini sur -1 dans tous les autres cas.
InstancesField[]Lecture seuleLe tableau de toutes les instances de ce champ. N’a de sens que si IsRepeatable est true. La propriété Instances peut être utilisée pour accéder aux instances d’un champ répétable dans un conteneur obtenu à l’aide de la méthode Field GetField.
IsConfirmedboolLecture/écritureRenvoie true si le champ a été validé par l’opérateur ou par une règle de validation.
IsRepeatableboolLecture seuleRenvoie true si le champ est répétable.
IsSuspiciousboolLecture seuleRenvoie true si des caractères de la valeur du champ ont été reconnus avec une faible confiance. La valeur d’un tel champ doit soit être relue manuellement par un opérateur, soit vérifiée par une règle.
IsValidboolLecture seuleRenvoie true si le texte reconnu du champ — stocké dans la propriété Text — a été converti avec succès en une valeur du type spécifié dans la propriété Value.
IsVisibleboolLecture seuleRenvoie true si le champ est visible sur le document.
NamestringLecture seuleLe nom du champ, unique au sein de son groupe.
ParentFieldLecture seuleLe champ parent.
ReadOnlyboolLecture seuleRenvoie true si le champ est en lecture seule et ne peut pas être modifié par l’opérateur de relecture manuelle.
SymbolsSymbol[]Lecture seuleUn tableau de caractères qui forment la valeur d’origine du champ au format texte.
TextstringLecture seuleLa valeur d’origine du champ au format texte (générée lors de la reconnaissance d’un document).
ValueobjectLecture/écritureLa valeur du champ dans le format spécifié (générée lors de la conversion du texte reconnu). Remarque : Contrairement à la propriété Text, la propriété Value stocke les valeurs dans un format normalisé. Si la valeur normalisée de la propriété Value est modifiée à la suite de l’exécution d’un script, la valeur de la propriété Text sera mise à jour avec la nouvelle valeur normalisée. Si la valeur normalisée de la propriété Value reste inchangée après l’exécution du script, la valeur de la propriété Text ne sera pas mise à jour.

​
Méthodes

NomDescription
void AddSuggestion(string value);Ajoute une valeur suggérée pour le champ. Cette méthode permet à un utilisateur de choisir la valeur dans la liste des valeurs suggérées. Les valeurs suggérées seront affichées lors de la relecture manuelle. Cette méthode ne peut pas être appliquée aux groupes de champs ni aux conteneurs de champs répétitifs.
void CopyTo(Field field);Copie les propriétés suivantes du champ passé en argument vers le champ actuel : Text, Value, ImageRegions, Symbols. Si le type du champ ou le type de données du champ ne sont pas identiques, la méthode renvoie une erreur.
Field GetChild(string fieldName);Renvoie un champ enfant portant le nom spécifié. Cette méthode facilite l’accès à différents éléments d’une même liste, par exemple à différentes cellules d’une même ligne. Important ! Passez directement à cette méthode le nom du champ sous forme de string : une variable ayant la même valeur string ne fonctionnera pas. Le préprocesseur qui analyse le code du script avant son exécution remplacera le nom du champ par son identifiant, mais ne pourra pas traiter une variable.