> ## 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. # Objets > Modèle objet pour les scripts personnalisés de Web Verification Station : fonctions pour les champs, les jeux de données et le formulaire du document, ainsi que commandArgs et les propriétés des champs. Vous trouverez ci-dessous la liste des fonctions disponibles pour créer des scripts personnalisés. Pour accéder aux instances d’objet, utilisez la variable commandArgs. Toutes les variables de cette section sont globales et visibles dans l’ensemble du programme.

Fonction

Description

getCurrentField()

Renvoie un lien vers l’objet Field qui utilise le script personnalisé actuel.

getFieldByName(namesPath) (\*)

Renvoie un lien vers le champ pour lequel le script personnalisé a été ouvert.

Exemple :
\['Document Section 1', 'Group\[10]','Field3'],
où \[10] est le numéro de l’instance du groupe répétitif.

  • namesPath est un tableau contenant les noms des champs et des groupes qui constituent le chemin vers le champ, ou un lien vers un objet champ.

getFieldValue(namesPath) (\*)

Renvoie :

  • une string pour un champ TextField ;
  • une valeur de coche pour un champ Checkmark ;
  • un tableau de string pour un champ Checkmark Group.

namesPath | fieldObject :

  • un tableau contenant les noms des champs et des groupes qui constituent le chemin vers le champ, ou un lien vers un objet champ,
  • ou un lien vers l'objet champ.

setCurrentFieldValue(value, forced, onSaved)

Modifie la valeur du champ pour lequel le script personnalisé a été ouvert.

Paramètres :

  • value – la valeur du champ.
  • forced – met à jour la valeur du champ et enregistre les nouvelles données. Ce paramètre est facultatif.
    • false – la valeur du champ dans la Document Definition ne sera mise à jour qu’après l’appel de la fonction save() .
    • true – la valeur du champ dans la Document Definition sera mise à jour immédiatement.

      Pour un script personnalisé, une mise à jour sera effectuée quel que soit le mode.
      Par défaut, ce paramètre est défini sur false.
  • onSaved – fonction de rappel. Appelée si le paramètre forced est défini sur true. Ce paramètre est facultatif.

setFieldValue(namesPath | field, value, forced, onSaved) (\*)

Modifie la valeur du champ.

Paramètres :

  • namesPath | fieldObject:
    • un tableau contenant les noms de champ et de Group qui forment le chemin d’accès au champ,
    • ou une référence à l’objet champ.
  • value – valeur du champ correspondant.
  • forced – met à jour la valeur du champ et enregistre les nouvelles données. Ce paramètre est facultatif.
    • false – la valeur du champ dans la Document Definition ne sera mise à jour qu’après l’appel de la fonction save() .
    • true – la valeur du champ dans la Document Definition sera mise à jour immédiatement.

      Pour un script personnalisé, la mise à jour aura lieu quel que soit le mode.
      Par défaut, ce paramètre est défini sur false.
  • onSaved – fonction de rappel. Appelée si le paramètre forced est défini sur true. Ce paramètre est facultatif.

save()

Ferme la fenêtre dans laquelle le script personnalisé s’exécute et enregistre les modifications.

cancel()

Ferme la fenêtre d’exécution du script personnalisé sans enregistrer les modifications.

(\*) Pour certaines fonctions répertoriées ci-dessus, le chemin d’accès au champ est spécifié en tant que paramètre d’entrée. Il comprend le nom du champ et les noms des éléments parents (groupe de champs, section). Pour les tableaux, les tableaux répétitifs et les groupes répétitifs, vous devez indiquer le numéro d’instance à partir de 0 (zéro).

Exemple :
\['Document Section 1', 'Group\[10]','Field3'],

où \[10] correspond au numéro d’instance du groupe répétitif.

Fonction

Description

addEntity(entityInfo: \{cacheName, columns, values}, onResult(newId))

Ajoute une entrée au jeu de données.

Paramètres :

  • entityInfo – un objet :
    • cacheName – un nom pour le jeu de données.
    • columns – les noms des colonnes dans lesquelles les données seront enregistrées. Tableau de string.
    • values – les valeurs des colonnes correspondantes. Tableau de string.
  • onResult – une fonction callback qui reçoit l’ID de l’enregistrement créé dans le jeu de données.

editEntity(entityInfo: \{cacheName, columns, values}, onResult())

Modifie une entrée dans la base de données.

Paramètres :

  • entityInfo – un objet :
    • cacheName – un nom pour le jeu de données.
    • columns – les noms des colonnes dans lesquelles les données seront enregistrées. Array de string.
    • values – les valeurs des colonnes correspondantes. Array de string.
  • onResult – une fonction de rappel.

getDict(\{cacheName, filters: \[\{FieldName, FieldValue}], cursorPos, allowMultipleColumnResults}, onResult (param: \{ FieldName, FieldValue, BoldMask}\[]\[]) )

Effectue une recherche dans un jeu de données pour une valeur spécifiée ou pour une partie de celle-ci. Retourne les string correspondantes au format suivant :

\[\{FieldName
FieldValue
BoldMask}].

Paramètres :

  • cacheName – le nom du jeu de données.
  • filters – les paramètres de recherche :
    • FieldName – le nom du champ. Laissez ce paramètre vide pour rechercher dans tous les champs.
    • FieldValue – la valeur du champ.
  • cursorPos – la position du curseur dans le champ de saisie.
    • Si une valeur a été saisie partiellement et que le curseur est placé après les symboles saisis, ceux-ci seront considérés comme un préfixe de la valeur recherchée.
    • Si le curseur est placé devant un mot saisi partiellement, ces symboles seront considérés comme la fin de la valeur recherchée.

      Par exemple, si, lors de la recherche d’un nom d’entreprise, vous saisissez "ADO" et que le curseur est placé après cette saisie, la valeur "AVOCADO" sera sélectionnée.
      Si vous saisissez "ADO" et que le curseur est placé devant cette saisie, la valeur "ADONIS" sera sélectionnée.
  • allowMultipleColumnResults – retourne les valeurs des champs trouvés.
    Le jeu de données peut contenir des entrées pour lesquelles un nom de champ (FieldName) correspond à plusieurs valeurs de champ (FieldValue). Par exemple, deux variantes ou plus du nom d’une entreprise peuvent être spécifiées dans la colonne CompanyName.

    Dans ce cas :
    • true – retourne et enregistre toutes les valeurs de champ qui satisfont aux conditions de recherche,
    • false – retourne et enregistre un seul résultat correspondant le mieux aux conditions de recherche.
  • onResult – une fonction callback qui retourne un tableau de résultats de recherche. Chaque résultat est une string unique du jeu de données, lui-même un tableau de string. Chaque string comprend le nom du champ, sa valeur et le paramètre BoldMask .

    BoldMask – une string de ‘0’ et de ‘1’ de la même longueur que la valeur trouvée lors de la recherche. ‘1’ représente un symbole de la valeur trouvée qui correspond au symbole correspondant dans le champ de recherche, et ‘0’ représente un symbole qui ne correspond pas.

Si, par exemple, le jeu de données contient ce qui suit :

CompanyName: ABBYY

Supposons qu’une recherche soit effectuée sur les symboles "ABB".

Alors, le résultat suivant sera retourné :

\[

\[

\{

FieldName: ‘CompanyName’,

FieldValue: ‘ABBYY’,

BoldMask: ‘11100’

},

]

]

Remarque : Le tableau retourné peut contenir plusieurs valeurs, y compris certaines qui ne correspondaient pas initialement aux conditions de recherche. Les résultats de recherche dans le tableau seront triés par valeur du paramètre BoldMask par ordre décroissant (c’est-à-dire en commençant par les string correspondant le mieux aux conditions de recherche).

getDictAll(\{cacheName, filters: \{FieldName, FieldValue}}, }, onResult (param: \{ FieldName, FieldValue, BoldMask}\[]\[]))

Effectue une recherche dans la base de données sur l’intégralité de la valeur spécifiée. Renvoie les valeurs de tous les champs trouvés.

Paramètres :

  • cacheName – le nom du jeu de données.
  • Filters – un tableau d’objets :
    • FieldName – le nom du champ. Pour effectuer une recherche dans tous les champs, laissez ce paramètre vide.
    • FieldValue – la valeur du champ.
  • onResult – une fonction de rappel qui renvoie un tableau de résultats de recherche. Chaque résultat est une string unique du jeu de données, elle-même constituée d’un tableau de string. Chaque string comprend le nom du champ, sa valeur et le paramètre BoldMask .

    BoldMask – une string composée de ‘0’ et de ‘1’, de la même longueur que la valeur trouvée lors de la recherche. '1' représente un symbole de la valeur trouvée qui correspond au symbole correspondant dans le champ de recherche, et '0' représente un symbole qui ne correspond pas.


    Si, par exemple, les éléments suivants sont présents dans un jeu de données :

    CompanyName: ABBYY

    Supposons qu’une recherche soit effectuée sur les symboles "ABB".

    Alors, les éléments suivants seront renvoyés :

\[

\[

\{

FieldName: ‘CompanyName’,

FieldValue: ‘ABBYY’,

BoldMask: ‘11100’

},

]

]

Remarque : Le tableau renvoyé peut contenir plusieurs valeurs, y compris certaines qui ne correspondaient pas initialement aux conditions de recherche. Les résultats de recherche dans le tableau seront triés par valeur du paramètre BoldMask par ordre décroissant (c’est-à-dire en commençant par les string qui correspondent le mieux aux conditions de recherche).

Exemple de script de recherche en base de données

Fonction

Description

selectRow(tablePath, rowNumber) (\*)

Marque une ligne du tableau comme sélectionnée.

  • tablePath | fieldObject:
    • un tableau de noms de champs et de groupes qui constituent le chemin vers le champ de tableau,
    • ou une référence à un objet tableau.
  • rowNumber – le numéro de la ligne à sélectionner, à partir de zéro.

deselectRow(tablePath, rowNumber?) (\*)

Supprime la sélection d'une ligne du tableau.

  • tablePath | fieldObject:
    • un tableau de noms de champs et de groupes qui constituent le chemin vers le champ de tableau,
    • ou une référence à un objet tableau.
  • rowNumber – le numéro de la ligne à désélectionner, à partir de zéro ; s'il est omis, la sélection est supprimée de toutes les lignes du tableau.

scrollFormToField(namesPath) (\*)

Fait défiler l'éditeur de formulaire pour afficher le champ.

  • namesPath | fieldObject:
    • un tableau de noms de champs et de groupes qui constituent le chemin vers le champ de tableau,
    • ou une référence à un objet tableau.

getDomElementPosition(domId, onResult: (result?: \{width, height, top, left, right, bottom}))

Obtient la position d'un élément dans la fenêtre de l'éditeur de formulaire et renvoie le résultat d'une fonction de rappel.

  • domId – ID de l'élément au format DOM.
  • onResult – une fonction de rappel qui reçoit l'objet contenant les coordonnées DOM de l'élément (width, height, top, left, right, bottom) par rapport au coin supérieur gauche de la fenêtre du navigateur.

setStyles(styles, callback)

Ajoute des styles CSS à la fenêtre du cadre d'action personnalisé.

  • styles – un objet contenant les noms et les valeurs des propriétés CSS.

    exemple:
    \{
    display: 'block',
    position: 'absolute',
    top: '0px',
    bottom: '0px',
    left: '0px',
    right: '0px',
    width: '100%',
    height: '100%',
    border: '0',
    overflow: 'hidden',
    'overflow-x': 'hidden',
    'overflow-y': 'hidden',
    'z-index': '10000'
    }
  • callback – une fonction de rappel.

(\*) Pour certaines fonctions répertoriées ci-dessus, le chemin vers le champ est indiqué comme paramètre d'entrée. Il comprend le nom du champ et les noms des éléments parents (groupe de champs, section). Pour les tableaux, les tableaux répétitifs et les groupes répétitifs, vous devez spécifier le numéro d'instance à partir de zéro.

Exemple:
\['Document Section 1', 'Group\[10]','Field3'],

où \[10] est le numéro de l'instance du groupe répétitif.
**Variables**

Variable

Type

Description

commandArgs.params.document

Document

Stocke une copie d'objet d'un document ouvert. Elle peut être utilisée pour accéder à toute erreur, tout champ ou toute région du document actif.

commandArgs.params.currentField

(Picture | Checkmark | Checkmark Groups | FieldsGroup | Table | TextField)

Renvoie une référence à un objet champ qui reflète l'état du champ au moment de l'appel du script. Il fait partie du document spécifié ci-dessus.

Remarque : Si la valeur du champ a été modifiée après l'initialisation du script, ces modifications ne seront pas prises en compte.

commandArgs.params.appPath

String

Le nom de domaine du serveur.

commandArgs.params.coordinates

Object
\[\{X1,X2,Y1,Y2}]

Les coordonnées de l'élément DOM qui a appelé le script personnalisé.

commandArgs.params.currentElementDomId

String

L'ID de l'élément DOM qui a appelé le script personnalisé.
**Fonctions** | **Fonction** | **Description** | | ------------------------------------- | ------------------------------------------------------------------------------------ | | commandArgs.events.addEventHandler | Ajoute un gestionnaire d'événement dans le contexte global du script personnalisé. | | commandArgs.events.triggerHandlers | Déclenche un événement dans le contexte global du script personnalisé. | | commandArgs.events.removeEventHandler | Supprime un gestionnaire d'événement dans le contexte global du script personnalisé. |

Nom

Type

Droits

Description

Fields

(Picture | Checkmark | Checkmark Groups | FieldsGroup | Table | TextField)\[]

Lecture seule

Tableau de champs

HasTableLayout

Boolean

Lecture seule

Indique si la région du champ correspond à un tableau.

Caption

String

Lecture seule

Nom du champ personnalisé, légende

FieldType

Number

Lecture seule

Type de champ. Valeur possible :

4 – groupe de champs

Id

Number

Lecture seule

ID du champ

IsReadOnly

Boolean

Lecture seule

Indique si la modification des champs est interdite.

IsVisible

Boolean

Lecture seule

Indique si le champ est visible dans le formulaire de données.

MaxRegions

Number

Lecture seule

Nombre maximal de régions de champ. Si la valeur est -1, un nombre quelconque de régions est autorisé.

Name

String

Lecture seule

Nom interne du champ.

NamePath

String\[]

Lecture seule

Tableau des noms de champs et de groupes qui forment le chemin vers le champ.

NeedRecognize

Boolean

Lecture/écriture

Indique s’il faut récupérer la valeur du champ depuis la région lorsque les règles sont à nouveau vérifiées.

Regions

\{
Id: number;
Status: number;
PageId: Number;
IsNew : Boolean;
Coordinates: Object
\[\{X1,X2,Y1,Y2}];
}\[]

Lecture seule

Tableau de régions.

  • Id – ID de la région.
  • Status – statut de la région.
    • 0 – région non superposée (ou région supprimée)
    • 1 – la région n’est pas reconnue
    • 2 – la valeur issue de la région est reportée dans le champ
  • PageId – ID de la page sur laquelle se trouve la région.
  • IsNew – indicateur signalant les nouvelles régions.
  • Coordinates – coordonnées de la région dans l’image.

Nom

Type

Droits

Description

Fields

(Picture | Checkmark | Checkmark Groups | FieldsGroup | Table | TextField)\[]

Lecture seule

Tableau de champs

Pageids

Number\[]

Lecture seule

Identifiants des pages sur lesquelles se trouve la section.

IsFlexible

Boolean

Lecture seule

Indique si la section est flexible.

Caption

String

Lecture seule

Nom du champ personnalisé (légende)

FieldType

Number

Lecture seule

Type de champ. Valeur possible :

6 – section

Id

Number

Lecture seule

ID du champ

IsReadOnly

Boolean

Lecture seule

Indique si la modification du champ est interdite

IsVisible

Boolean

Lecture seule

Indique si le champ est visible dans le formulaire de données.

MaxRegions

Number

Lecture seule

Nombre maximal de régions du champ. Si la valeur est -1, un nombre quelconque de régions est autorisé.

Name

String

Lecture seule

Nom interne du champ

NamePath

String\[]

Lecture seule

Tableau des noms de champs et de groupes qui forment le chemin vers le champ.

NeedRecognize

Boolean

Lecture/écriture

Indique s’il faut extraire la valeur du champ à partir de la région lorsque les règles sont à nouveau vérifiées.

Regions

\{
Id: number;
Status: number;
PageId: Number;
IsNew : Boolean;
Coordinates: Object
\[\{X1,X2,Y1,Y2}];
}\[]

Lecture seule

Tableau de régions.

  • Id – ID de la région.
  • Status – statut de la région.
    • 0 – région non superposée (ou région supprimée)
    • 1 – la région n’est pas reconnue
    • 2 – la valeur de la région est reportée dans le champ
  • PageId – ID de la page sur laquelle se trouve la région.
  • IsNew – indicateur signalant les nouvelles régions.
  • Coordinates – coordonnées de la région dans l’image.

Nom

Type

Droits

Description

Lignes

\{
Id: number;
RowNumber: number;
HasColorImage: boolean;
TableBlockID: number\[];
Cells: (Picture | Checkmark | CheckmarkGroup | TextField)\[];
}\[]

Lecture seule

Liste des lignes du tableau.

Paramètres de l’objet ligne du tableau :

  • Id – ID de la ligne.
  • RowNumber – le numéro d’ordre de la ligne, à partir de zéro.
  • TableBlockId – identifiants des sections, tableaux et blocs de tableau qui forment le chemin vers le bloc de tableau.
  • Cells – champs dans les cellules de tableau. Les champs peuvent être des types suivants : image, coche, groupe de coches, texte.

Intitulé

String

Lecture seule

Nom du champ personnalisé, intitulé

FieldType

Number

Lecture seule

Type de champ. Valeur possible :

7 – tableau

ID

Nombre

Lecture seule

ID du champ

IsReadOnly

Boolean

Lecture seule

Indique si le champ ne peut pas être modifié.

IsVisible

Booléen

Lecture seule

Indique si le champ est visible dans le formulaire de données.

MaxRegions

Number

Lecture seule

Indique si le champ est visible dans le formulaire de données ; -1 signifie qu’un nombre quelconque de régions est autorisé.

Name

string

Lecture seule

Nom de service du champ.

NamePath

String\[]

Lecture seule

Tableau des noms de champ et de groupe qui constituent le chemin d’accès au champ.

NeedRecognize

Boolean

Lecture/écriture

Indique s’il faut récupérer la valeur du champ depuis la région lors d’une nouvelle vérification des règles.

Régions

\{
Id: number;
Status: number;
PageId: Number;
IsNew : Boolean;
Coordinates: Object
\[\{X1,X2,Y1,Y2}];
}\[]

Lecture seule

Tableau de régions.

  • Id – ID de la région.
  • Status – statut de la région.
    • 0 – région non superposée (ou région supprimée)
    • 1 – la région n’est pas reconnue
    • 2 – la valeur de la région est reportée dans le champ
  • PageId – ID de la page sur laquelle se trouve la région.
  • IsNew – indicateur signalant les nouvelles régions.
  • Coordinates – coordonnées de la région dans l’image.

Nom

Type

Droits

Description

Flags

Number\[]

Lecture/écriture

tableau de même longueur que le champ Value. Il se compose de 0 et de 1.

0 – un caractère situé dans Value à la même position que le 0 dans Flags nécessite une vérification.

Suggestions

String\[]

Lecture seule

Liste de valeurs des champs suggérées

Value

String

Lecture/écriture

Valeur du champ

TextType

Number

Lecture seule

Type du champ Text. Valeurs possibles :

  • 0 – champ Text.
  • 1 – champ numérique.
  • 2 – champs de montant en devise.
  • 3 – champ DateTime.
  • 4 – champ Date.
  • 5 – champ Time.
  • 6 – champ Code.

Libellé

String

Lecture seule

Nom du champ personnalisé, libellé

FieldType

Number

Lecture seule

Type de champ. Valeur possible :

0 – champ Text

ID

Numéro

Lecture seule

ID du champ

IsReadOnly

Booléen

Lecture seule

Indique si la modification du champ est interdite.

IsVisible

Boolean

Lecture seule

Indique si le champ est visible dans le formulaire de données.

MaxRegions

Number

Lecture seule

Nombre maximal de régions associées au champ. Si la valeur est -1, n’importe quel nombre de régions est autorisé.

Name

String

Lecture seule

Nom de service du champ.

NamePath

String\[]

Lecture seule

Tableau des noms de champs et de groupes constituant le chemin d'accès au champ.

NeedRecognize

Boolean

Lecture/écriture

Indique si la valeur du champ doit être récupérée à partir de la région lors d’une nouvelle vérification des règles.

Régions

\{
Id: number;
Status: number;
PageId: Number;
IsNew : Boolean;
Coordinates: Object
\[\{X1,X2,Y1,Y2}];
}\[]

Lecture seule

Tableau de régions.

  • Id – ID de la région.
  • Status – statut de la région.
    • 0 – région non superposée (ou région supprimée)
    • 1 – la région n’est pas reconnue
    • 2 – la valeur de la région est reportée dans le champ
  • PageId – ID de la page sur laquelle se trouve la région.
  • IsNew – indicateur signalant les nouvelles régions.
  • Coordinates – coordonnées de la région dans l’image.

IsVerified

Booléen

Lecture/écriture

Indique si le champ a été vérifié.

NeedVerification

Boolean

Lecture seule

Indique si le champ doit être vérifié.

NeedDoubleVerification

Booléen

Lecture seule

Indique si le champ nécessite une double vérification

IsSummary

Booléen

Lecture seule

Indique si le champ est utilisé pour générer le résumé des données dans le formulaire de données.

Nom

Type

Droits

Description

Value

Booléen

Lecture/écriture

Valeur du champ

Libellé

String

Lecture seule

Nom du champ personnalisé, libellé

FieldType

Number

Lecture seule

Type de champ. Valeur possible :

2 – coche

ID

Nombre

Lecture seule

ID du champ

IsReadOnly

Booléen

Lecture seule

Indique si le champ ne peut pas être modifié.

IsVisible

Booléen

Lecture seule

Indique si le champ est visible sur le formulaire de données.

MaxRegions

Number

Lecture seule

Nombre maximal de régions de champ. Si la valeur est -1, tout nombre de régions est autorisé.

Name

String

Lecture seule

Nom de service du champ.

NamePath

String\[]

Lecture seule

Tableau des noms de champ et de groupe constituant le chemin d’accès du champ.

NeedRecognize

Booléen

Lecture/écriture

Indique si la valeur du champ doit être récupérée à partir de la région lorsque les règles sont à nouveau vérifiées.

Régions

\{
Id: number;
Status: number;
PageId: Number;
IsNew : Boolean;
Coordinates: Object
\[\{X1,X2,Y1,Y2}];
}\[]

Lecture seule

Tableau de régions.

  • Id – ID de la région.
  • Status – statut de la région.
    • 0 – région non superposée (ou région supprimée)
    • 1 – la région n’est pas reconnue
    • 2 – la valeur de la région est reportée dans le champ
  • PageId – ID de la page sur laquelle se trouve la région.
  • IsNew – indicateur signalant les nouvelles régions.
  • Coordinates – coordonnées de la région dans l’image.

IsVerified

Boolean

Lecture/écriture

Indique si le champ a été vérifié.

NeedVerification

Booléen

Lecture seule

Indique si le champ doit être vérifié.

NeedDoubleVerification

Boolean

Lecture seule

Indique si le champ nécessite une double vérification.

IsSummary

Boolean

Lecture seule

Indique si le champ est utilisé pour générer le récapitulatif des données dans le formulaire de données.

Nom

Type

Autorisations

Description

MaxSelectedCount

Number

Lecture seule

Nombre maximal de valeurs des champs sélectionnées.

MinSelectedCount

Number

Lecture seule

Nombre minimum de valeurs de champ sélectionnées.

Valeurs

Number\[]

Lecture/écriture

Valeur du champ. Tableau d’ID d’enregistrements constituant la liste des valeurs possibles du champ (Variantes).

Variantes

\{Id:number, Name:string}\[]

Lecture seule

Liste des valeurs possibles du champ :

  • Id – ID de l’enregistrement
  • Name – nom de l’enregistrement

Libellé

String

Lecture seule

Nom du champ personnalisé, libellé

FieldType

Number

Lecture seule

Type de champ. Valeur possible :

3 – groupe de coches

ID

Nombre

Lecture seule

ID du champ.

IsReadOnly

Boolean

Lecture seule

Indique si la modification du champ est interdite.

IsVisible

Boolean

Lecture seule

Indique si le champ est visible dans le formulaire de données.

MaxRegions

Number

Lecture seule

Nombre maximal de régions de champ. Si la valeur est -1, un nombre quelconque de régions est autorisé.

Name

String

Lecture seule

Nom de service du champ.

NamePath

String\[]

Lecture seule

Tableau des noms de champ et de groupe constituant le chemin du champ.

NeedRecognize

Boolean

Lecture/écriture

Indique s’il faut récupérer la valeur du champ depuis la région lorsque les règles sont vérifiées à nouveau.

Régions

\{
Id: number;
Status: number;
PageId: Number;
IsNew : Boolean;
Coordinates: Object
\[\{X1,X2,Y1,Y2}];
}\[]

Lecture seule

Tableau de régions.

  • Id – ID de la région.
  • Status – statut de la région.
    • 0 – région non superposée (région supprimée)
    • 1 – la région n’est pas reconnue
    • 2 – la valeur de la région est reportée dans le champ
  • PageId – ID de la page sur laquelle se trouve la région.
  • IsNew – indicateur signalant les nouvelles régions.
  • Coordinates – coordonnées de la région dans l’image.

IsVerified

Booléen

Lecture/écriture

Indique si le champ a été vérifié.

NeedVerification

Booléen

Lecture seule

Indique si le champ doit être vérifié.

NeedDoubleVerification

Booléen

Lecture seule

Indique si le champ nécessite une double vérification.

IsSummary

Booléen

Lecture seule

Indique si le champ est utilisé pour générer le résumé des données dans le formulaire de données.

Nom

Type

Droits

Description

Caption

String

Lecture seule

Nom du champ personnalisé, légende

FieldType

Number

Lecture seule

Type de champ. Valeur possible :

1 – image

Id

Number

Lecture seule

ID du champ.

IsReadOnly

Boolean

Lecture seule

Indique si la modification du champ est interdite.

IsVisible

Boolean

Lecture seule

Indique si le champ est visible dans le formulaire de données.

MaxRegions

Number

Lecture seule

Nombre maximal de régions du champ. Si la valeur est -1, un nombre quelconque de régions est autorisé.

Name

String

Lecture seule

Nom interne du champ.

NamePath

String\[]

Lecture seule

Tableau des noms de champs et de groupes qui forment le chemin d’accès au champ.

Regions

\{
Id: number;
Status: number;
PageId: Number;
IsNew : Boolean;
Coordinates: Object
\[\{X1,X2,Y1,Y2}];
}\[]

Lecture seule

Tableau de régions.

  • Id – ID de la région.
  • Status – statut de la région.
    • 0 – région non superposée (ou région supprimée)
    • 1 – région non reconnue
    • 2 – la valeur de la région est insérée dans le champ
  • PageId – ID de la page sur laquelle se trouve la région.
  • IsNew – indicateur signalant les nouvelles régions.
  • Coordinates – coordonnées de la région dans l’image.

Nom

Type

Droits

Description

Id

Number

Lecture seule

ID du champ

Name

String

Lecture seule

Nom du champ

Sections

Section\[]

Lecture seule

Tableau de champs de type Section

FieldType

Number

Lecture seule

Type de champ.

Valeur possible :

8 – groupe répétitif de sections.

Nom

Type

Droits

Description

AssemblingErrors

\{
DocumentNodeRef: number\[]\[];
Description: string;
SectionName: string\[]
}\[]

Lecture seule

Erreurs d’assemblage dans le document :

  • DocumentNodeRef – liste de liens sous forme de tableau d’ID de champs vers les champs du formulaire
  • Description – description de l’erreur
  • SectionName – liste des sections impliquées dans l’erreur

BatchId

Number

Lecture seule

L’ID du package

Erreurs

\{
DocumentNodeRef: number\[]\[];
Severity: number;
Message: string;
RuleName: string;
}\[]

Lecture seule

Erreurs dans le document :

  • DocumentNodeRef – liste de références sous forme de tableau d'ID de champ vers les champs du formulaire
  • Severity:
    • 1 – Erreur,
    • 0 – Avertissement
  • Message – texte de l'erreur
  • RuleName – nom de la règle à l'origine de l'erreur

Fields

(Section | SectionsGroup)\[]

Lecture seule

Liste des sections/sections dupliquées

ID

Nombre

Lecture seule

Identifiant du document

Index

Number

Lecture seule

Indice du document dans le package

Pages

\{
Id: number;
Modification: number;
HasColorImage: boolean;
ImageResolution: number;
KeyValue: string;
SectionTemplateId: number;
SectionTemplateName: string;
FlexibleInstanceId: number;
SectionTemplatePageNumber: number;
Comment: string;
ImageWidth: number;
ImageHeight: number;
}\[]

Lecture seule

Liste des pages de document contenant les éléments suivants :

  • Id – ID de la page
  • Modification – le numéro de révision de la page
  • HasColorImage – spécifie si la page est en couleur
  • ImageResolution – résolution de l’image
  • KeyValue – la valeur du champ clé de la page
  • SectionTemplateId – ID de la section de la page
  • SectionTemplateName – nom de la section de la page
  • SectionTemplatePageNumber – le numéro de la page dans la section
  • Comment – commentaire de relecture de la page
  • ImageWidth – largeur de la page d’image
  • ImageHeight – hauteur de l’image de la page

ProjectId

Nombre

Lecture seule

Identifiant du projet

TaskId

Nombre

Lecture seule

ID de tâche

TemplateId

Nombre

Lecture seule

ID de définition du document

TemplateName

String

Lecture seule

Le nom du document de définitions

TemplateVersion

Nombre

Lecture seule

Version de la définition du document

Version

Nombre

Lecture seule

Version du document