commandArgs.
Toutes les variables de cette section sont globales et visibles dans l’ensemble du programme.
Chemins des champs
0 (zéro).
Par exemple, ['Document Section 1', 'Group[10]', 'Field3'], où [10] est le numéro de l’instance du groupe répétitif.
Fonctions pour manipuler fields
getCurrentField
getCurrentField()
Renvoie un lien vers l’objet Field qui utilise le script personnalisé actuel.
getFieldByName
getFieldByName(namesPath)
Renvoie un lien vers le champ pour lequel le script personnalisé a été ouvert.
getFieldValue
getFieldValue(namesPath)
Renvoie la valeur du champ : une chaîne pour un champ TextField, une valeur de coche pour un champ Checkmark ou un tableau de chaînes pour un champ Checkmark Group.
setCurrentFieldValue
setCurrentFieldValue(value, forced, onSaved)
Modifie la valeur du champ pour lequel le script personnalisé est ouvert.
setFieldValue
setFieldValue(namesPath | field, value, forced, onSaved)
Modifie la valeur d’un champ.
save
save()
Ferme la fenêtre dans laquelle le script personnalisé s’exécute et enregistre les modifications.
cancel
cancel()
Ferme la fenêtre d’exécution du script personnalisé sans enregistrer les modifications.
Fonctions pour manipuler les jeux de données
addEntity
addEntity(entityInfo: {cacheName, columns, values}, onResult(newId))
Ajoute une entrée au jeu de données.
editEntity
editEntity(entityInfo: {cacheName, columns, values}, onResult())
Modifie une entrée de la base de données.
getDict
getDict({cacheName, filters: [{FieldName, FieldValue}], cursorPos, allowMultipleColumnResults}, onResult(param: {FieldName, FieldValue, BoldMask}[][]))
Recherche une valeur spécifiée, ou une partie de celle-ci, dans le jeu de données.
BoldMask est une chaîne composée de 0 et de 1, de même longueur que la valeur trouvée. 1 indique un symbole de la valeur trouvée qui correspond au symbole correspondant dans le champ de recherche, tandis que 0 indique un symbole qui ne correspond pas.
Par exemple, si un jeu de données contient CompanyName: ABBYY et qu’une recherche est effectuée pour les symboles ABB, le résultat suivant est renvoyé :
BoldMask, en commençant par les chaînes qui correspondent le mieux aux conditions de recherche.
getDictAll
getDictAll({cacheName, filters: {FieldName, FieldValue}}, }, onResult(param: {FieldName, FieldValue, BoldMask}[][]))
Recherche dans la base de données la valeur complète spécifiée. Renvoie les valeurs de tous les champs trouvés.
BoldMask est une chaîne de 0 et de 1 de même longueur que la valeur trouvée. 1 indique un symbole de la valeur trouvée qui correspond au symbole correspondant dans le champ de recherche, tandis que 0 indique un symbole qui ne correspond pas.
Par exemple, si un jeu de données contient CompanyName: ABBYY et qu’une recherche est effectuée sur les symboles ABB, le résultat suivant est renvoyé :
BoldMask décroissante, en commençant par les chaînes qui correspondent le mieux aux conditions de recherche.
Pour un exemple complet, consultez Exemple de script de recherche dans une base de données.
Fonctions pour travailler avec le formulaire du document
selectRow
selectRow(tablePath, rowNumber)
Marque une ligne du tableau comme sélectionnée.
deselectRow
deselectRow(tablePath, rowNumber?)
Désélectionne une ligne de tableau.
scrollFormToField
scrollFormToField(namesPath)
Fait défiler l’éditeur de formulaire pour afficher le champ.
getDomElementPosition
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.
setStyles
setStyles(styles, callback)
Ajoute des styles CSS à la fenêtre du cadre de l’action personnalisée.
Objet commandArgs
Variables
Événements
Types d’objets Field
Regions.
Champ de groupe
Champ Section
Champ de tableau
Objet Row
Champ de saisie de texte
Valeurs de TextType
Champ de coche
Champ de groupe de coches
Champ image
Champ Groupe répétitif de sections
Objet Region
Regions de chaque objet champ renvoie un tableau de régions présentant la structure suivante.
Objet Document
commandArgs.params.document.
