← Gesamte Dokumentation

editor.execCommand(command, value)

Führt einen Editor-Befehl per Namen auf der aktuellen Auswahl aus – dieselben Befehle, die die Schaltflächen der Symbolleiste aufrufen. Das ist der wichtigste Weg, den Editor über eigene Schaltflächen, Tastenkürzel oder Automatisierung zu steuern: Formatierung (bold, forecolor), Einfügen (insertimage, inserttable), Umschalten der Ansicht (fullscreenenter) und mehr.

Syntax

editor.execCommand(command, value)

Parameter

command – der Name des Befehls (ohne Unterscheidung von Groß- und Kleinschreibung). Die vollständige Liste finden Sie unter Alle Befehle.

value – optional. Manche Befehle brauchen einen Wert – zum Beispiel erwartet forecolor eine Farbe und formatblock ein Tag wie h2.

Rückgabewert

false, wenn der Befehl deaktiviert oder blockiert ist; andernfalls wird der Befehl ausgeführt.

Hinweise zum Verhalten

  • Bei Befehlsnamen spielt Groß- und Kleinschreibung keine Rolle. Sie werden intern kleingeschrieben, daher verhalten sich Bold und bold gleich.
  • Deaktivierte Befehle werden übersprungen. Ist ein Befehl gerade nicht aktiviert, gibt execCommand() false zurück, ohne etwas zu tun – prüfen Sie vorher isCommandEnabled(), wenn Sie es im Voraus wissen müssen.
  • Jeder Befehl lässt sich abfangen. Vor der Ausführung löst der Editor ein Ereignis exec_command aus (und ein befehlsspezifisches Ereignis exec_command_<name>); gibt Ihr Handler einen Wert zurück, ersetzt das das eingebaute Verhalten.

Anwendungsbeispiel

Einen Ansichtsbefehl umschalten:

var editor1 = new RichTextEditor("#div_editor1");
editor1.execCommand("fullscreenenter");

Einen Befehl ausführen, der einen Wert braucht:

editor1.execCommand("forecolor", "red");
editor1.execCommand("formatblock", "h2");

Eine eigene Schaltfläche mit einem Formatierungsbefehl verbinden:

document.getElementById("btn_bold").onmousedown = function (e) {
    e.preventDefault();            // keep focus in the editor
    editor1.execCommand("bold");
};

Siehe auch