Objet Scope dans les fonctions personnalisées
Dans les Forms adaptatives, un objet de portée est transmis en tant que dernier argument aux fonctions lorsqu’une règle est exécutée. Il peut être utilisé pour lire les propriétés de formulaire/champ et modifier le formulaire au sein des fonctions. L’objet scope contient un objet proxy en lecture seule pour le formulaire, l’événement déclenché et le champ cible. Les propriétés de formulaire et de champ sont accessibles à l’aide de l’objet scope en ajoutant $, par exemple scope.form.$id et scope.field.$id, respectivement.
Fonctions de modification de formulaire utilisant l’objet scope
L’objet Scope dispose des fonctions suivantes pour la modification du formulaire :
Fonction
Syntaxe
Description
Exemple de code
setProperty
setProperty(any $element, any $payload)Définit une propriété de
$element à l’aide de $payload.Cliquez ici pour afficher l’exemple.
validate
validate([any $element])Exécute la validation sur
$element. Si aucun élément n’est fourni, le formulaire entier est validé.Cliquez ici pour afficher l’exemple.
reset
reset([any $element])Réinitialise le
$element. Si aucun élément n’est fourni, il réinitialise l’intégralité du formulaire.Cliquez ici pour afficher l’exemple.
importData
importData(any $payload)Importe les données dans le formulaire, en remplaçant toutes les données de formulaire existantes.
Cliquez ici pour afficher l’exemple.
submitForm
submitForm(any $data [, boolean $validate_form = true, string $submit_as = 'multipart/form-data'])Déclenche l’envoi d’un formulaire. Le paramètre
$data spécifie ce qui doit être envoyé et $submit_as définit le type de contenu (par défaut "multipart/form-data"). L’ $validate_form facultatif détermine si le formulaire doit être validé (par défaut : true). En cas de succès, submitSuccess est déclenché ; en cas d’échec, submitError est déclenché.Cliquez ici pour afficher l’exemple.
setFocus
setFocus(any $element [, FocusOption $focusOption])Définit la cible d’action sur le
$element, qui peut être un panneau ou un champ. Si aucun élément n’est fourni, le focus est défini sur le champ qui a déclenché la règle. Le paramètre facultatif $focusOption (de type énumération FocusOption) indique s’il faut se concentrer sur 'nextItem' ou 'previousItem' par rapport à $element. Si un panneau est spécifié, la navigation est limitée à ce panneau ; avec un champ, la navigation se fait dans le panneau parent.Cliquez ici pour afficher l’exemple.
dispatchEvent
dispatchEvent(any $element, string $eventName [, any $payload])Détermine un événement de type
$eventName sur l’élément spécifié par $element. Si aucun élément n’est fourni, l’événement est distribué sur le formulaire. Le $payload facultatif est mis à la disposition des expressions gérant l’événement.Cliquez ici pour afficher l’exemple.
markFieldAsInvalid
markFieldAsInvalid(string $fieldIdentifier, string $validationMessage [, any $option = {useId: true}])Marque le champ identifié par
$fieldIdentifier comme non valide et définit le message de validation sur $validationMessage. Le paramètre facultatif $option spécifie si $fieldIdentifier est interprété comme id, name ou dataRef. La valeur par défaut est {useId: true} et les valeurs prises en charge sont {useId: true}, {useDataRef: true} et {useQualifiedName: true}.Cliquez ici pour afficher l’exemple.
Voir également
- Présentation de l’éditeur de règles pour les formulaires adaptatifs basés sur les composants principaux
- Types d’opérateurs et événements dans l’éditeur de règles d’un formulaire adaptatif basé sur les composants principaux
- Interface d’utilisation de l’éditeur de règles pour les formulaires adaptatifs basés sur les composants principaux
- Différents cas d’utilisation de l’éditeur de règles pour un formulaire adaptatif basé sur les composants principaux
- Différence des diverses éditions de l’éditeur de règles
- Utiliser des fonctions asynchrones dans un formulaire adaptatif
- Améliorations du service Invoke dans l’éditeur de règles visuel pour les formulaires basés sur des composants principaux
- Présentation des fonctions personnalisées des formulaires adaptatifs basés sur les composants principaux
- Créer une fonction personnalisée pour un formulaire adaptatif basé sur les composants principaux
- Objet portée dans les fonctions personnalisées
- Exemples de développement et d’utilisation d’une fonction personnalisée
recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab