← Toda a documentação

editor.execCommand(command, value)

Executa um comando do editor pelo nome sobre a seleção atual — os mesmos comandos que os botões da barra de ferramentas acionam. É a principal forma de controlar o editor a partir dos seus próprios botões, atalhos de teclado ou automações: formatação (bold, forecolor), inserção (insertimage, inserttable), alternância de visualização (fullscreenenter) e muito mais.

Sintaxe

editor.execCommand(command, value)

Parâmetros

command — o nome do comando (não diferencia maiúsculas de minúsculas). Veja todos os comandos para a lista completa.

value — opcional. Alguns comandos precisam de um valor — por exemplo, forecolor recebe uma cor, e formatblock recebe uma tag como h2.

Retorno

false quando o comando está desabilitado ou bloqueado; caso contrário, o comando é executado.

Observações de comportamento

  • Os nomes de comando não diferenciam maiúsculas de minúsculas. Eles são convertidos para minúsculas internamente, então Bold e bold se comportam da mesma forma.
  • Comandos desabilitados são ignorados. Se um comando não estiver habilitado no momento, execCommand() retorna false sem fazer nada — verifique antes com isCommandEnabled() se você precisar saber disso com antecedência.
  • Todo comando pode ser interceptado. Antes de executar, o editor dispara um evento exec_command (e um evento exec_command_<name> específico de cada comando); retornar um valor do seu handler substitui o comportamento integrado.

Exemplo de uso

Alternar um comando de visualização:

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

Executar um comando que precisa de um valor:

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

Ligar um botão personalizado a um comando de formatação:

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

Relacionados