Passer au contenu principal
Fournit un accès en lecture seule à un champ, à sa valeur et à ses paramètres.

Propriétés

NomTypeNiveau d’accèsDescription
ChildrenField[]Lecture seuleLe tableau des champs enfants. Cette propriété n’est valable que pour les conteneurs de champs répétables.
DataTypeDataTypeLecture seuleLe type de données du champ.
FieldTypeFieldTypeLecture seuleLe type du champ.
FullNamestringLecture seuleLe chemin complet vers le nom depuis la racine du document. Utilise la barre oblique (/) comme séparateur, par ex. Vendor/Address/Street.
HasRegionboolLecture seuleRenvoie true si le champ a été trouvé dans le document, c.-à-d. si une région correspondante existe sur le document. Une valeur false indique que l’image du document ne contient aucune région correspondant à ce champ.
IdstringLecture seuleL’identifiant du champ défini dans la définition du document.
ImageRegionsImageRegionListLecture seuleUn 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 à -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.
IsConfirmedboolLecture seuleRenvoie true si le champ a été vérifié 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 certains caractères de la valeur du champ ont été reconnus de manière non fiable. La valeur d’un tel champ doit soit être revue manuellement par un opérateur, soit être contrôlée par une règle.
IsValidboolLecture seuleRenvoie true si le texte reconnu du champ (la propriété Text) a été correctement converti en la valeur du type requis (la propriété Value).
IsVisibleboolLecture seuleRenvoie true si le champ est visible dans 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 constituent la valeur d’origine d’un champ au format texte.
TextstringLecture seuleLa valeur d’origine d’un champ au format texte (générée lors de la reconnaissance du document).
ValueobjectLecture seuleLa valeur d’un champ dans le format spécifié (générée lors de la conversion du texte reconnu).

Méthodes

NomDescription
Field GetChild(string fieldDefinitionId);Renvoie un champ enfant avec l’identifiant spécifié.