Passer au contenu principal

Propriétés

NameTypeDescription
ChildrenField[], lecture seuleChamps enfants.
DataTypeDataType, lecture seuleType de données du champ.
FieldTypeFieldOcrType, lecture seuleType de champ (par exemple texte, code‑barres ou image).
FullNamestring, lecture seuleChemin racine complet vers le document. Les noms des champs parents sont séparés par le symbole « / ». Par exemple, le champ d’adresse d’un fournisseur peut s’appeler « Vendor/Address ».
Idstring, lecture seuleIdentifiant d’une définition de champ dans la définition de document.
InstanceIdstring, lecture seuleIdentifiant d’une instance de champ. Un document peut ne comporter aucune instance d’un champ ; dans ce cas, InstanceId = null.
InstanceIndexnumber, lecture seuleNuméro d’index de l’instance de champ actuelle parmi tous les champs répétables du même type. Cette propriété s’applique uniquement aux champs répétables.
InstancesField[], lecture seuleToutes les instances de ce type de champ. Cette propriété s’applique uniquement aux champs répétables.
IsConfirmedboolean, lecture seuleRetourne true si la valeur a été confirmée par un opérateur lors de la vérification.
IsRepeatableboolean, lecture seuleRetourne true s’il s’agit d’un champ répétable.
IsSuspiciousboolean, lecture seuleRetourne true si l’algorithme n’est pas certain des résultats de reconnaissance pour ce champ.
IsValidboolean, lecture seuleRetourne true si le texte du champ (Text) a été correctement converti en une valeur du type attendu (Value). Retourne false sinon.
IsVisibleboolean, lecture seuleRetourne true si le champ peut être consulté par un opérateur. Si le champ a été masqué lors de la vérification, retourne false.
Namestring, lecture seuleNom du champ.
ParentField, lecture seuleChamp parent.
RegionsRegionsCollection, lecture seuleRégions de l’image où se trouve le champ.
Textstring, lecture seuleTexte du champ tel que détecté sur le document.
ValueobjectValeur du champ une fois convertie au type de données approprié, p. ex. date ou nombre à virgule flottante.
ImageBinaryFile, lecture seuleImage au format binaire. S’applique uniquement aux champs de type Picture.

Méthodes

NameDescription
AddInstance(any value?);Pour les champs non répétitifs : met à jour la valeur d’une instance de champ existante ou crée une instance si elle n’existe pas. Pour les champs répétitifs : crée une nouvelle instance de champ. Renvoie l’objet Field créé ou mis à jour.
Remove();Supprime le champ.