5.7.7 Déclencher des événements

Il est possible de déclencher manuellement des événements.

5.7.7.1 triggerEvent

Cette méthode permet de déclencher un événement sur le widget en cours.

Le fait de déclencher un événement ne lance pas l'action associée. Par exemple, le fait de déclencher un beforeSave ne la,nce pas la sauvegarde du document.

5.7.7.1.1 Arguments

nom (string)

nom de l'événement à déclencher.

Il est possible de déclencher les événements standards.
D'autres événements peuvent être déclenchés à condition que leur nom soit préfixé par custom:.

autres arguments (un ensemble d'arguments)

ensemble d'arguments, ces arguments sont transférés aux méthodes écoutant les événements.

5.7.7.1.2 Retour

Booléen :

• si true l'événement doit s'exécuter (pas de preventDefault),
• si false l'événement a été annulé par un des écouteurs.

5.7.7.1.3 Exception

Le nom de l'événement n'est pas valide.

Les noms valides sont tous les noms d'événements standards et les noms préfixés par custom:.

5.7.7.1.4 Exemple

Déclenchement et écoute de l'événement custom:MyEvent.

 
window.dcp.document.documentController("addEventListener",
    "custom:MyEvent",
    function(event, documentProperties, date) {
        console.log("MyEvent", event, documentProperties, date);
    }
);
 
window.dcp.document.documentController( "triggerEvent", 
                                        "custom:MyEvent", 
                                        window.dcp.document.documentController("getProperties"), 
                                        Date());