Zum Hauptinhalt springen

announce()

Beschreibung​

Gibt eine Meldung an Screenreader-Nutzer aus

Verwendung​

announce(message: string): void;

Parameter​

  • message - (erforderlich) der Text, der angekündigt werden soll. Ein leerer String löscht die Meldung

Beispiel​

Im folgenden Beispiel zählt ein benutzerdefinierter Menübefehl die leeren Zellen im ausgewählten Bereich und gibt das Ergebnis aus:

const spreadsheet = new dhx.Spreadsheet("spreadsheet_container", {
menu: true,
// other config parameters
});
spreadsheet.parse(data);

spreadsheet.menu.data.add({
id: "count-empty",
value: "Count empty cells"
});

spreadsheet.menu.events.on("click", function (id) {
if (id === "count-empty") {
let count = 0;
spreadsheet.eachCell(function (cell, value) {
if (value === "" || value === undefined || value === null) count++;
}, spreadsheet.selection.getSelectedCell());
spreadsheet.announce(count + " empty cells in the selection");
}
});

Details​

Verwenden Sie die Methode, um Screenreader-Nutzer über das Ergebnis einer Aktion zu informieren, die kein eigenes sichtbares Element hat, etwa ein benutzerdefinierter Toolbar- oder Menübefehl.

Die Meldung geht an eine visuell verborgene Live-Region, die direkt nach dem Grid-Element platziert ist (role="status", aria-live="polite", aria-atomic="true"). Der Screenreader liest sie vor, nachdem er die aktuelle Ausgabe beendet hat, und der Tastaturfokus wird nicht verschoben.

Das Spreadsheet gibt seine eigenen Meldungen über dieselbe Region aus: den ausgewählten Bereich, neue Formelfehler und ungültige Werte, abgelehnte Änderungen, Suchergebnisse, Beginn und Ende von Import und Export sowie neue Spaltenbreiten und Zeilenhöhen (siehe die Liste der Statusmeldungen). Die Region enthält jeweils nur eine Meldung, sodass eine neuere Meldung, ob eigene oder integrierte, die vorherige ersetzt.

Wenn Sie den Text übergeben, der sich gerade in der Region befindet, liest der Screenreader ihn erneut vor.

Die Methode funktioniert auch im schreibgeschützten Modus und bei ausgeschalteter Auswahl. Sie tut nichts, bevor das Spreadsheet in die Seite eingebunden wurde, und nachdem die Methode destructor() aufgerufen wurde.

Changelog: Hinzugefügt in v6.0.4

Verwandte Artikel: