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 à un champ de document — sa valeur, ses paramètres et sa structure. Dans un script, vous pouvez modifier la valeur d’un champ ou ajouter des valeurs suggérées qui sont affichées aux opérateurs de relecture manuelle.

​
Propriétés

​
Children

Type: Field[] — Access: Lecture seule Le tableau des champs enfants. Valide uniquement pour les champs de groupe.

​
DataType

Type: DataType — Accès: Lecture seule Le type de données du champ.

​
FieldType

Type: FieldType — Access: Lecture seule Le type de champ — par exemple, du texte, une coche ou un tableau (contenant des cellules qui représentent d’autres champs).

​
FullName

Type: string — Access: Lecture seule Le chemin complet du champ depuis la racine du document. Utilise une barre oblique (/) comme Separator — par exemple, Vendor/Address/Street.

​
HasRegion

Type: bool — Access: Lecture/écriture true si le champ a été trouvé dans le document (une région lui est associée sur l’image). false signifie qu’aucune région correspondante n’a été trouvée.

​
HasSuspiciousSymbols

Type: bool — Access: Lecture seule true si la valeur du champ contient des caractères reconnus avec un faible niveau de confiance.

​
Id

Type: string — Accès: Lecture seule L’identifiant du champ, unique dans le document.

​
ImageRegions

Type: ImageRegionList — Access: Lecture/écriture Tableau des régions du champ sur l’image.

​
InstanceIndex

Type: int — Access: Lecture seule L’indice de l’instance actuelle d’un champ répétitif. Défini sur -1 pour les champs non répétitifs.

​
Instances

Type : Field[] — Accès : Lecture seule Le tableau de toutes les instances de ce champ (champs répétitifs uniquement). Utilisez Instances pour accéder aux instances de champs répétitifs dans un conteneur obtenu via GetField.

​
IsConfirmed

Type: bool — Access: Lecture/écriture true si le champ a été vérifié par un opérateur ou par une règle de validation.

​
IsRepeatable

Type : bool — Access : Lecture seule true si le champ est répétitif.

​
IsSuspicious

Type: bool — Access: Lecture seule true si un ou plusieurs caractères de la valeur du champ ont été reconnus avec un faible niveau de confiance. Ces champs doivent faire l’objet d’une relecture manuelle ou être vérifiés par une règle.

​
IsValid

Type: bool — Access: Lecture seule true si le texte reconnu dans Text a été converti avec succès en une valeur du type spécifié dans Value.

​
IsVisible

Type: bool — Access: Lecture seule true si le champ est visible sur le document.

​
Name

Type : string — Accès : Lecture seule Le nom du champ, unique dans son groupe.

​
Parent

Type: Field — Access: Lecture seule Le champ parent.

​
ReadOnly

Type: bool — Access: Lecture seule true si le champ est en lecture seule et ne peut pas être modifié pendant la relecture manuelle.

​
Symbols

Type: Symbol[] — Access : Lecture seule Tableau des caractères qui composent la valeur d’origine du champ au format texte.

​
Text

Type: string — Access: Lecture seule La valeur d’origine du champ au format texte (générée lors de la reconnaissance du document).

​
Value

Type: object — Accès : Lecture/écriture La valeur du champ au format spécifié (générée lors de la conversion du texte reconnu).
Contrairement à Text, la propriété Value stocke la valeur normalisée. Si un script modifie Value en une autre valeur normalisée, Text est mis à jour avec la nouvelle forme normalisée. Si Value reste inchangé après l’exécution du script, Text n’est pas mis à jour.

​
Méthodes

​
AddSuggestion

void AddSuggestion(string value);
Ajoute une valeur suggérée au champ. Lors de la relecture manuelle, les opérateurs peuvent la sélectionner dans la liste des valeurs suggérées.
Non pris en charge pour les groupes de champs ou les conteneurs de champs répétitifs.

​
CopyTo

void CopyTo(Field field);
Copie Text, Value, ImageRegions et Symbols du champ passé en argument vers le champ actuel. Renvoie une erreur si les deux champs ont des types de données différents.

​
GetChild

Field GetChild(string fieldName);
Renvoie le champ enfant portant le nom spécifié. Utilisez GetChild pour accéder aux éléments d’une liste — par exemple, à différentes cellules d’une même ligne.
Passez le nom du champ sous la forme d’un littéral de chaîne, et non d’une variable. Le préprocesseur de script remplace le nom littéral par l’identifiant du champ avant l’exécution — les variables ne sont pas traitées.

Modèle objet

Référence complète du modèle objet JavaScript à utiliser dans Advanced Script Rules.

Context

Objet global Context — permet d’accéder au document, aux champs et aux paramètres du Skill dans une règle.

FieldType

Énumération des types de champ disponibles et des types de données pris en charge par chacun.

DataType

Énumération des types de données qu’un champ peut contenir (y compris AmountOfMoney pour les valeurs monétaires).