element.dispatchEvent

Résumé

Envoie un évènement dans le système d'évènements. L'évènement est toujours soumis au même comportement de capture et de propagation que les évènements envoyés directement.

Syntaxe

bool = élément.dispatchEvent(évènement)

Paramètres

élément 

La cible (target) de l'évènement.

évènement 

Un objet event à envoyer.

bool 

La valeur renvoyée est false si au moins un des gestionnaires d'évènements gérant cet évènement a appelé preventDefault. Dans les autres cas, la valeur renvoyée est true.

Exemple

Cet exemple montre la simulation d'un clic sur une case à cocher, à l'aide des méthodes DOM. Vous pouvez le voir en action ici.

function simulateClick() {
  var evt = document.createEvent("MouseEvents");
  evt.initMouseEvent("click", true, true, window,
    0, 0, 0, 0, 0, false, false, false, false, 0, null);
  var cb = document.getElementById("checkbox"); 
  var canceled = !cb.dispatchEvent(evt);
  if(canceled) {
    // Un gestionnaire a appelé preventDefault
    alert("canceled");
  } else {
    // Aucun gestionnaire n'a appelé preventDefault
    alert("not canceled");
  }
}

Notes

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 manuellement dans le modèle évènementiel de l'implémentation.

L'évènement peut-être créé avec la méthode document.createEvent et initialisé avec initEvent ou toute autre méthode d'initialisation plus spécifique, comme initMouseEvent ou initUIEvent.

Voir également

• Référence de DOM Event.

Spécification

• DOM Level 2 Events: dispatchEvent (en) — traduction en français (non normative)