WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / JavaScript

Selection: Bereiche mit rangeCount zählen und mit addRange() hinzufügen

`rangeCount` gibt an, wie viele Bereiche die Dokumentauswahl enthält. `addRange()` fügt einen DOM-Bereich hinzu. Um die Auswahl browserübergreifend durch einen Bereich zu ersetzen, hebe sie zuerst auf.

Version: Current web platform; runtime support varies

Syntax

// Web platform: Selection API (not part of ECMAScript).
const selection = window.getSelection(); // Selection | null
if (selection !== null) {
  const count = selection.rangeCount;    // read-only number
  selection.addRange(range);            // takes a Range; returns undefined
}

Selection stellt die Auswahl im Dokument oder die Position der Einfügemarke dar. Rufe das Objekt mit window.getSelection() ab und prüfe, ob das Ergebnis null ist. Diese API gehört zur Webplattform, nicht zu ECMAScript 2024. Für Text in einem textarea oder einem unterstützten input-Typ verwende stattdessen die Elementmethode setSelectionRange().

rangeCount ist eine schreibgeschützte Zahl. Sie zählt Range-Objekte, keine Zeichen. 0 bedeutet, dass kein Bereich vorhanden ist. Auch ohne hervorgehobenen Text kann rangeCount === 1 gelten: Ein auf einen Punkt reduzierter Bereich zählt mit. Prüfe vor getRangeAt(0), ob rangeCount > 0 ist, denn ein Index außerhalb des gültigen Bereichs löst eine Ausnahme aus.

addRange(range) nimmt ein Range-Objekt entgegen und gibt undefined zurück. Der Rückgabewert verrät also nicht, ob der Bereich hinzugefügt wurde. Erzeuge einen Bereich mit document.createRange() und lege seine Grenzen fest, etwa mit range.selectNodeContents(node) für einen Knoten, der im selben Dokument eingebunden ist. Ein Range-Objekt ist dynamisch: Änderungen am DOM können seine Grenzen verschieben.

Laut Spezifikation enthält eine Auswahl höchstens einen Bereich, Firefox unterstützt jedoch mehrere. Ein Browser, der nur einen Bereich unterstützt, kann einen weiteren Aufruf von addRange() ignorieren, statt den vorhandenen Bereich zu ersetzen. Rufe zuerst removeAllRanges() auf, um zuverlässig einen einzelnen neuen Bereich zu setzen. Das hebt die bisherige Auswahl auf, löscht aber keinen Dokumentinhalt.

Beispiele

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>Selection API example</title>
</head>
<body>
  <script>
    (() => {
      const selection = window.getSelection();
      if (selection === null) throw new Error("No document selection available");

      const paragraph = document.createElement("p");
      paragraph.textContent = "CKTIS";
      document.body.append(paragraph);

      try {
        const range = document.createRange();
        range.selectNodeContents(paragraph);

        selection.removeAllRanges();
        console.log(selection.rangeCount);
        selection.addRange(range);
        console.log(selection.rangeCount);
        console.log(selection.toString());
      } finally {
        selection.removeAllRanges();
        paragraph.remove();
      }
    })();
  </script>
</body>
</html>

Ergebnis

0
1
CKTIS

Speichere das Beispiel als `.html`-Datei, öffne sie in einem separaten Browser-Tab und prüfe die Entwicklerkonsole. Der Code gibt nach dem Aufheben der Auswahl `0` aus, nach dem Hinzufügen des Bereichs `1` und `CKTIS`. Am Ende hebt er die Auswahl auf und entfernt den temporären Absatz; die vorherige Auswahl wird nicht wiederhergestellt.

Zugehörige Lektionen

  • JavaScript · Lektion 33 · Mittlere Stufe · Version: 3

Quellen