Partager via

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

  • Article

Cet événement se produit avant que la phase d’un contrôle de flux des processus d’entreprise change. Cet événement se produit après que l’utilisateur sélectionne les boutons Phase suivante, Revenir à la phase précédente ou Définir une phase active dans l’interface utilisateur ou qu’un développeur utilise les méthodes formContext.data.process.moveNext, formContext.data.process.movePrevious ou formContext.data.process.setActiveStage.

Notes

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 appelez 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 disposant des méthodes suivantes :

  • getDirection : Renvoie une chaîne qui est Next ou Previous pour indiquer la direction du changement de phase.
  • getStage : Renvoie un objet de phase. 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. Informations complémentaires : Méthodes de la phase.

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

  • Méthode formContext.data.process.addOnPreStageChange pour ajouter des gestionnaires d’événements pour l’événement.
  • Méthode formContext.data.process.removeOnPreStageChange pour supprimer des gestionnaires d’événements pour l’événement.

Notes

Pouvez-vous nous indiquer vos préférences de langue pour la documentation ? Répondez à un court questionnaire. (veuillez noter que ce questionnaire est en anglais)

Le questionnaire vous prendra environ sept minutes. Aucune donnée personnelle n’est collectée (déclaration de confidentialité).