← Toda la documentación

editor.execCommand(command, value)

Ejecuta un comando del editor por su nombre sobre la selección actual: los mismos comandos que invocan los botones de la barra de herramientas. Es la forma principal de controlar el editor desde tus propios botones, atajos de teclado o automatizaciones: formato (bold, forecolor), inserción (insertimage, inserttable), cambios de vista (fullscreenenter) y más.

Sintaxis

editor.execCommand(command, value)

Parámetros

command: el nombre del comando (no distingue mayúsculas y minúsculas). Consulta todos los comandos para ver la lista completa.

value: opcional. Algunos comandos necesitan un valor; por ejemplo, forecolor recibe un color y formatblock recibe una etiqueta como h2.

Valor devuelto

false cuando el comando está desactivado o bloqueado; en caso contrario, el comando se ejecuta.

Notas de comportamiento

  • Los nombres de comando no distinguen mayúsculas y minúsculas. Se pasan a minúsculas internamente, así que Bold y bold se comportan igual.
  • Los comandos desactivados se omiten. Si un comando no está habilitado en ese momento, execCommand() devuelve false sin hacer nada; consulta antes isCommandEnabled() si necesitas saberlo de antemano.
  • Todos los comandos se pueden interceptar. Antes de ejecutarse, el editor lanza un evento exec_command (y un evento exec_command_<name> por comando); devolver un valor desde tu controlador sustituye el comportamiento integrado.

Ejemplo de uso

Alterna un comando de vista:

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

Ejecuta un comando que necesita un valor:

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

Conecta un botón personalizado a un comando de formato:

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

Relacionado