CKTIS / HTML
onclose — ein close-Ereignis behandeln
Das onclose-Attribut enthält JavaScript-Code zur Behandlung des close-Ereignisses. Typischerweise reagiert man damit auf das Schließen eines dialog-Elements, etwa indem man dessen returnValue ausliest. Es verhindert das Schließen nicht.
Version: WHATWG HTML Living Standard; index snapshot date recorded separately
Syntax
onclose="JavaScript statements"onclose ist ein globales Event-Handler-Attribut für close. Sein Wert ist JavaScript-Code, kein boolescher Wert. Es kann auf jedem HTML-Element stehen, doch allein durch das Attribut wird ein Element nicht dazu gebracht, dieses Ereignis auszulösen.
Typischerweise wird es mit dem Element dialog verwendet. Der Aufruf von close() schließt einen geöffneten Dialog und reiht ein close-Ereignis zur Ausführung ein. Im Attribut-Handler verweist this auf das Element, und event stellt das Ereignisobjekt bereit. Das Schließungsergebnis lässt sich über this.returnValue auslesen.
Das close-Ereignis eines dialog-Elements bubbelt nicht und kann nicht abgebrochen werden. Um eine Schließanforderung zu verhindern, muss das abbrechbare cancel-Ereignis behandelt werden; close() selbst überspringt diesen Schritt. Das manuelle Entfernen des open-Attributs löst kein close aus.
Unterscheide das Attribut von der JavaScript-Eigenschaft element.onclose, der eine Funktion zugewiesen wird, und von addEventListener('close', handler), mit dem sich mehrere Listener registrieren lassen. Im Beispiel liest der Handler das Ergebnis done aus und aktualisiert den Text erst, nachdem das eingereihte Ereignis ausgeliefert wurde.
Beispiele
<!doctype html>
<meta charset="utf-8">
<title>onclose</title>
<dialog id="demo" onclose="document.getElementById('result').textContent = 'closed: ' + this.returnValue">
<p>Dialog</p>
</dialog>
<output id="result">waiting</output>
<script>
const dialog = document.getElementById('demo');
dialog.show();
dialog.close('done');
</script>Ergebnis
closed: done
Der angezeigte Code und das angegebene Ergebnis wurden in einer isolierten Umgebung mit der im Prüfnachweis für genau diese Version dokumentierten Methode verifiziert.