Partager via

Événement OnPreStageChange (référence de l’API client)

  • Article

Cet événement se produit Avant que l’étape d’un contrôle flux des processus d’entreprise ne change. Cet événement se produit après que l’utilisateur a sélectionné les boutons Étape suivante, Passer à l’étape précédente ou Définir l’étape active dans l’interface utilisateur ou lorsqu’un développeur utilise les méthodes formContext.data.process.moveNext, formContext.data.process.movePrevious ou formContext.data.process.setActiveStage .

Note

L’événement OnPreStageChange est pris en charge uniquement dans Unified Interface.

Dans un script de ressource web enregistré pour l’événement onPreStageChange, le développeur peut appeler ce qui suit sur l’objet executionContext transmis dans les scripts de ressource web :

executionContext.getEventArgs().preventDefault();

Lorsque vous invoquez preventDefault :

  • La navigation dans les phases ne sera pas traitée. L’instance de processus reste à la phase d’origine.
  • Dans une navigation entre tables, la forme de la table de l′étape de destination ne s′ouvre pas.
  • L’enregistrement du formulaire principal ne sera pas traité. Si le formulaire principal est dans un état modifié, il demeurera à un état modifié.
  • Toutes les ressources web ayant enregistré onStageChange ne sont pas appelées.

Un objet de contexte d’exécution est transmis aux gestionnaires d’événements pour cet événement. Vous pouvez utiliser la méthode getEventArgs pour récupérer un objet qui possède les méthodes suivantes :

  • getDirection : renvoie une chaîne qui indique soit Next soit Previous la direction du changement d’étape.
  • getStage : renvoie un objet d’étape. La phase renvoyée représente l’objet de phase de destination, c’est-à-dire la prochaine phase active, sauf si la navigation passe à une nouvelle table. Lorsque la navigation passe à une nouvelle table, la phase correspond à celle qui est quittée, c’est-à-dire la précédente phase active. Plus d’informations : Méthodes par étapes.

Méthodes prises en charge pour cet événement

  • formContext.data.process.addOnPreStageChange méthode pour ajouter des gestionnaires d’événements pour cet événement.
  • formContext.data.process.removeOnPreStageChange méthode pour supprimer les gestionnaires d’événements pour cet événement.

Événements (référence API client)
Événements dans les formulaires et les grilles dans les applications pilotées par modèle