Base de connaissancesCentre d’examen
FRFrançais
Choisir la langue13

CKTIS / HTML

oncancel — gérer l’événement cancel

L’attribut oncancel contient le code exécuté lorsqu’un événement cancel est reçu. Sur un élément dialog, il permet de réagir à une demande de fermeture et, si l’événement est annulable, d’empêcher la fermeture.

Version : WHATWG HTML Living Standard; index snapshot date recorded separately

Syntaxe

oncancel="JavaScript statements"
element.oncancel = function (event) { /* ... */ };

oncancel est un attribut de gestionnaire d’événement pour cancel, disponible sur tous les éléments HTML. Sa valeur est du code JavaScript, et non un nom d’événement ou une valeur booléenne. Son équivalent JavaScript est la propriété element.oncancel, à laquelle on peut affecter une fonction ou null.

L’élément dialog en est un usage courant : cancel signale une demande de fermeture, et non une fermeture déjà effectuée. La méthode requestClose() déclenche d’abord cancel ; la méthode close() saute cette étape. L’événement close indique, lui, la fermeture.

Lorsque event.cancelable vaut true, event.preventDefault() empêche la fermeture par défaut. Renvoyer false depuis un gestionnaire oncancel annule également l’événement s’il est annulable. Ne partez pas du principe que toutes les demandes de fermeture peuvent être bloquées.

L’exemple ouvre une boîte de dialogue non modale et appelle requestClose(). L’attribut empêche la fermeture ; le résultat enregistré est donc open: true. Le dernier appel à close() retire la boîte de dialogue de l’affichage sans déclencher cancel une nouvelle fois.

Exemples

<!doctype html>
<meta charset="utf-8">
<title>oncancel</title>
<dialog id="demo" oncancel="event.preventDefault()">
  <p>Dialog</p>
</dialog>
<pre id="result"></pre>
<script>
  const demo = document.getElementById('demo');
  const result = document.getElementById('result');
  demo.show();
  demo.requestClose();
  result.textContent = `open: ${demo.open}`;
  demo.close();
</script>

Résultat

open: true

Le code affiché et le résultat déclaré ont été vérifiés dans un environnement isolé selon la méthode consignée dans la preuve de vérification de cette version exacte.

Sources