element.dispatchEvent

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.

Envoie un Event (évènement) à la EventTarget (cible) spécifiée (synchrone) en appelant les EventListener (écouteurs) dans l'ordre approprié. Le processus normal de traitement de l'évènement (y compris les phases de capture et l'éventuelle propagation) s'applique aussi aux évènements diffusés manuellement avec dispatchEvent().

Syntaxe

js
cancelled = !target.dispatchEvent(event);

Paramètres

  • event est un objet Event à envoyer.
  • target (cible) est utilisée pour initialiser la Event.target et déterminer quels écouteurs d'évènements doivent être invoqués.

Valeur retournée

  • La valeur de retour est false (faux) si l'évènement est annulable et au moins l'un des gestionnaires d'événements qui ont géré cet événement appelé Event.preventDefault (). Sinon, elle est true (vrai).

La méthode dispatchEvent lance une exception UNSPECIFIED_EVENT_TYPE_ERR si le type de l'évènement n'a pas été spécifié par son initialisation avant l'appel de la méthode ou s'il est null ou une chaîne vide. Les exceptions lancées par les gestionnaires d'évènements sont signalées comme exceptions non interceptées ; les gestionnaires d'événements s'exécutent sur une pile d'appels imbriquée : ils bloquent l'appelant jusqu'à ce qu'ils se terminent, mais les exceptions ne se propagent pas à l'appelant.

Notes

Contrairement aux événements "natifs", qui sont déclenchés par le DOM et invoquent les gestionnaires d'événements de manière asynchrone via la boucle des événements, dispatchEvent appelle les gestionnaires d'événements de manière synchrone. Tous les gestionnaires d'événements applicables s'exécuteront et retourneront avant que le code ne continue après l'appel à dispatchEvent.

Comme montré dans l'exemple qui précède, dispatchEvent est la dernière étape du processus création-initialisation-envoi, qui est utilisé pour envoyer des évènements dans le modèle de l'implémentation des évènements. Ceux-ci peuvent être créés en utilisant le constructeur d'évènements.

Voir aussi Objet Event référence.

Exemple

Voir Création et déclenchement d'évènements.

Spécifications

Specification
DOM Standard
# ref-for-dom-eventtarget-dispatchevent③

Compatibilité des navigateurs

BCD tables only load in the browser