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 valide 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 du nom depuis la racine du document. Utilise une barre oblique (/) comme séparateur, p. ex. Vendor/Address/Street.
HasRegionboolLecture seuleRetourne true si le champ a été trouvé dans le document, c’est-à-dire si 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.
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 vaut 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 vaut true.
IsConfirmedboolLecture seuleRetourne true si le champ a été vérifié par l’opérateur ou par une règle de validation.
IsRepeatableboolLecture seuleRetourne true si le champ est répétable.
IsSuspiciousboolLecture seuleRetourne true si certains caractères de la valeur du champ ont été reconnus de manière peu fiable. La valeur d’un tel champ doit être soit revue lors d’une relecture manuelle par un opérateur, soit contrôlée par une règle.
IsValidboolLecture seuleRetourne true si le texte reconnu du champ (la propriété Text) a été converti avec succès en une valeur du type requis (la propriété Value).
IsVisibleboolLecture seuleRetourne 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 seuleRetourne true si le champ est en lecture seule et ne peut pas être modifié par l’opérateur lors de la relecture manuelle.
SymbolsSymbol[]Lecture seuleUn tableau de caractères formant 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 d’un 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é.