Objets

Renvoie un lien vers un objet de champ basé sur un tableau de noms dans la demande.

Exemple :
['Document Section 1', 'Group[10]','Field3']
where [10] correspond au numéro de l'instance du groupe répétitif dans Groupe.

• namesPath est un tableau contenant les noms des champs et des groupes qui constituent le chemin d'accès au champ ou un lien vers un objet de champ.

Renvoie :

• une chaîne pour un champ TextField ;
• une valeur de coche pour un champ Checkmark ;
• un tableau de chaînes pour un champ Checkmark Group.

namesPath | fieldObject :

• un tableau contenant les noms des champs et des groupes qui constituent le chemin d'accès au champ ou un lien vers un objet de champ,
• ou un lien vers l'objet de champ.

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

Paramètres :

• value – la valeur de champ.
• forced - Indique si la valeur sera enregistrée dans le champ immédiatement après la modification du champ ou seulement après avoir appelé la fonction save(). Ce paramètre est facultatif et est défini sur False par défaut.
• false – dans la définition de document, la valeur de champ ne sera mise à jour qu'après l'appel de la fonction save().
• true – dans la définition de document, la valeur de champ sera mise à jour immédiatement.
  
  Dans le cas d'un script personnalisé, une mise à jour aura lieu quel que soit le mode.
  Par défaut, ce paramètre est réglé sur false.

• onSaved - Une fonction de rappel. La fonction est appelée si le paramètre forced est défini sur True. Ce paramètre est facultatif.

Modifie les valeurs de champ.

Paramètres :

• namesPath | fieldObject :
• un tableau contenant des noms de champ et de groupe qui constituent le chemin d'accès au champ,
• ou un lien vers l'objet de champ.
• value - la valeur du champ correspondant.
• forced - met à jour la valeur de champ et enregistre les nouvelles données. Ce paramètre est facultatif.
• false - dans la définition de document, la valeur de champ ne sera mise à jour qu'après l'appel de la fonction save() .
• true - dans la définition de document, la valeur de champ sera mise à jour immédiatement.
  
  Dans le cas d'un script personnalisé, une mise à jour aura lieu quel que soit le mode.
  Par défaut, ce paramètre est réglé sur False.

• onSaved - Une fonction de rappel. La fonction est appelée si le paramètre forced est défini sur True. Ce paramètre est facultatif

(*) Pour certaines fonctions énumérées ci-dessus, le chemin d'accès au champ est spécifié comme paramètre d'entrée. Il inclut 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 nombre d'instances en partant de 0 (zéro).

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

où [10] est le nombre d'instances du groupe répétitif.

Ajoute 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. Tableau de chaînes.
• values - les valeurs des colonnes correspondantes. Tableau de chaînes.
• onResult - une fonction de rappel qui reçoit l'identificateur de l'enregistrement créé dans le jeu de données.

Modifie une entrée de 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. Tableau de chaînes.
• values - les valeurs des colonnes correspondantes. Tableau de chaînes.
• onResult - une fonction de rappel.

Procède à la recherche d'un jeu de données pour une valeur donnée ou pour une partie de celle-ci. Renvoie les chaînes correspondantes au format suivant :

[{FieldName
FieldValue
BoldMask}].

Paramètres :

• cacheName – Définit le nom du jeu de données.
• filters – des paramètres de recherche :
• FieldName – le nom du champ. À ignorer pour rechercher tous les champs.
• FieldValue – Définit la valeur du champ.
• cursorPos – Définit un emplacement pour le curseur dans un champ d'entrée.
• Dans le cas où une valeur a été saisie partiellement et que le curseur est placé après les symboles tapés, ils seront considérés comme un préfixe de la valeur recherchée.
• Si le curseur est placé avant un mot partiellement tapé, ces symboles seront considérés comme la fin de la valeur recherchée.
  
  Par exemple, si, lors de la recherche d'un nom de société, vous tapez « AB » et placez le curseur après ces caractères, la valeur « ABBYY » sera sélectionnée.
  Si vous tapez « AB » et placez le curseur devant ces caractères, la valeur « Mention Q LAB » sera sélectionnée.

• allowMultipleColumnResults - renvoie les valeurs des champs qui ont été 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 ou plusieurs variantes du nom d'une société peuvent être spécifiées dans la colonne CompanyName.
  
  Dans ce cas :
• true - renvoie et enregistre toutes les valeurs de champ qui satisfont aux conditions de recherche,
• false - renvoie et enregistre celui des résultats qui correspond le mieux aux conditions de recherche.
• onResult - une fonction de rappel qui renvoie un tableau de résultats de recherche. Chaque résultat est une chaîne unique du jeu de données, qui est un tableau de chaînes. Chaque chaîne inclut le nom de champ, sa valeur et le paramètre BoldMask .
  
  BoldMask - une chaîne de 0 et 1 de même longueur quela valeur trouvée lors de la recherche. 1 représente un symbole de la valeur trouvée qui concorde avec le symbole correspondant du champ de recherche et 0 représente un symbole qui ne présente pas cette concordance.

Si, par exemple, ce qui suit est présent dans un jeu de données :

CompanyName : ABBYY

Supposons qu'une recherche soit effectuée pour les symboles « AB ».

Voici ce qui sera alors renvoyé :

[

  [

     {

           FieldName : CompanyName,

           FieldValue : ABBYY,

           BoldMask : 11000

      },

  ]

]

Effectue une recherche dans la base de données pour la totalité de la valeur spécifiée. Renvoie les valeurs de tous les champs qui ont été 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 à partir de tous les champs, ce champ doit être laissé 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 chaîne unique du jeu de données, qui est en lui-même un tableau de chaînes. Chaque chaîne inclut le nom de champ, sa valeur et le paramètreBoldMask .
  
  BoldMask – une chaîne de 0 et 1 de même longueur quela valeur trouvée durant la recherche. 1 représente un symbole de la valeur trouvée qui concorde avec le symbole correspondant du champ de recherche et 0 représente un symbole qui ne présente pas cette concordance.
  
  
  Si, par exemple, ce qui suit est présent dans un jeu de données :
  
  CompanyName: ABBYY
  
  Supposons qu'une recherche soit effectuée pour les symboles « AB ».
  
  Voici ce qui sera alors renvoyé :

[

  [

     {

           FieldName : CompanyName,

           FieldValue : ABBYY,

           BoldMask : 11000

      },

  ]

]

Marque une ligne d'un tableau comme sélectionnée.

• tablePath | fieldObject :
• un tableau des noms des champs et des groupes qui constituent le chemin d'accès au champ tableau,
• ou un lien vers un objet du tableau.
• rowNumber - le numéro de la ligne à sélectionner, à partir de zéro.

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

• tablePath | fieldObject :
• un tableau des noms des champs et des groupes qui constituent le chemin d'accès au champ tableau,
• ou un lien vers un objet du tableau.
• rowNumber - le numéro de la ligne à désélectionner, à partir de zéro, en son absence, la sélection est supprimée de toutes les lignes du tableau.

Fait défiler l'éditeur de formulaires pour faire apparaître le champ.

• namesPath | fieldObject :
• un tableau des noms des champs et des groupes qui constituent le chemin d'accès au champ tableau,
• ou un lien vers un objet du tableau.

Indique la position d'un élément dans la fenêtre de l'éditeur de formulaires 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 avec les coordonnées DOM de l'élément (largeur, hauteur, haut, gauche, droite, bas) par rapport au coin supérieur gauche de la fenêtre du navigateur.

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

• styles - un objet avec les noms et valeurs de la propriété CSS.
  
  exemple :
  {
  affichage : 'bloc',
  position : 'absolue',
  haut : '0px',
  bas : '0px',
  gauche : '0px',
  droite : '0px',
  largeur : '100%',
  hauteur : '100%',
  bordure : '0',
  chevauchement : 'masqué',
  'chevauchement-x' : 'masqué',
  'chevauchement-y' : 'masqué',
  'z-index' : '10000'
  }
• callback - une fonction de rappel.

(*) Pour certaines fonctions énumérées ci-dessus, le chemin d'accès au champ est spécifié comme paramètre d'entrée. Il inclut 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 nombre d'instances en partant de 0.

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

où [10] est le nombre d'instances du groupe répétitif.

Type de champ. Valeur possible :

4 - groupe de champs

Tableau de régions.

• Id - identifiant 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 remplacée dans le champ
• PageId - identifiant de la page dans laquelle se trouve la région.
• IsNew - indicateur pour signaler les nouvelles régions.
• Coordinates – coordonnées de la région dans l'image.

Type de champ. Valeur possible :

6 – section

Tableau de régions.

• Id - identifiant 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 remplacée dans le champ
• PageId - identifiant de la page dans laquelle se trouve la région.
• IsNew - indicateur pour signaler les nouvelles régions.
• Coordinates – coordonnées de la région dans l'image.

Liste des lignes d'un tableau.

Les paramètres de la ligne objet dans le tableau :

• Id - identifiant de la ligne.
• RowNumber - le numéro d'ordre de la ligne, en comptant à partir de zéro.
• TableBlockId - les identificateurs des sections, des tableaux, des blocs de tableaux constituant le chemin d'accès au bloc de tableaux.
• Cells - les champs dans les cellules du tableau. Les champs peuvent être des types suivants : image, coche, groupe de coches, texte.

Type de champ. Valeur possible :

7 - tableau

Tableau de régions.

• Id - identifiant 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 remplacée dans le champ
• PageId - identifiant de la page dans laquelle se trouve la région.
• IsNew - indicateur pour signaler les nouvelles régions.
• Coordinates – coordonnées de la région dans l'image.

tableau de la même longueur que le champ Valeur. Se compose de 0 et 1.

0 - un caractère qui, dans Valeur, est à la même position que celle occupée par 0 dans Indicateurs, nécessite une vérification.

Type de champ de texte. Valeur possible :

• 0 - champ de texte.
• 1 - champ numérique.
• 2 - champs du montant en devise.
• 3 - champ DateTime.
• 4 - champ de la date.
• 5 - champ de l'heure.
• 6 - champ du code.

Type de champ. Valeur possible :

0 - champ de texte

Tableau de régions.

• Id - identifiant 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 remplacée dans le champ
• PageId - identifiant de la page dans laquelle se trouve la région.
• IsNew - indicateur pour signaler les nouvelles régions.
• Coordinates – coordonnées de la région dans l'image.

Type de champ. Valeur possible :

2 - coche

Tableau de régions.

• Id - identifiant 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 remplacée dans le champ
• PageId - identifiant de la page dans laquelle se trouve la région.
• IsNew - indicateur pour signaler les nouvelles régions.
• Coordinates – coordonnées de la région dans l'image.

Liste des valeurs de champ possibles :

• Id - identifiant de l'enregistrement
• Name - nom de l'enregistrement

Type de champ. Valeur possible :

3 - groupe de coches

Tableau de régions.

• Id - identifiant de la région.
• Status - statut de la région.
• 0 - région non superposée (la région est supprimée)
• 1 - région non reconnue
• 2 - la valeur de la région est remplacée dans le champ
• PageId - identifiant de la page dans laquelle se trouve la région.
• IsNew - indicateur pour signaler les nouvelles régions.
• Coordinates – coordonnées de la région dans l'image.

Type de champ. Valeur possible :

1 - image

Tableau de régions.

• Id - identifiant 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 remplacée dans le champ
• PageId - identifiant de la page dans laquelle se trouve la région.
• IsNew - indicateur pour signaler les nouvelles régions.
• Coordinates – coordonnées de la région dans l'image.

Type de champ.

Valeur possible :

8 - groupe de sections récurrent.

Erreurs de construction dans le document lorsque :

• DocumentNodeRef - une liste de liens vers les champs du formulaire sous la forme d'un tableau d'identifiants de champs
• Description - une description de l'erreur
• SectionName - une liste des sections impliquées dans l'erreur

Erreurs dans le document lorsque :

• DocumentNodeRef - une liste de liens vers les champs du formulaire sous la forme d'un tableau d'identifiants de champs
• Severity :
• 1 - Erreur,
• 0 - Avertissement
• Message - texte d'erreur
• RuleName - le nom de la règle à l'origine de l'erreur

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

• Id - identifiant de la page
• Modification - le nombre de révisions de la page
• HasColorImage - indique la couleur de la page
• ImageResolution - la résolution de l'image
• KeyValue - la valeur de la page du champ clé
• SectionTemplateId - la section Identifiant de la page
• SectionTemplateName - le nom de la section de la page
• SectionTemplatePageNumber - le nombre de pages dans la section
• Comment - l'analyse de la page
• ImageWidth - la largeur de la page Image
• ImageHeight - la hauteur de l'image de la page