← すべてのドキュメント

editor.execCommand(command, value)

現在の選択範囲に対して、エディターのコマンドを名前で実行します。ツールバーのボタンが呼び出すのと同じコマンドです。独自のボタン、キーボードショートカット、自動化からエディターを操作する主な方法で、書式設定(bold、forecolor)、挿入(insertimage、inserttable)、表示の切り替え(fullscreenenter)などに使えます。

構文

editor.execCommand(command, value)

パラメーター

command — コマンド名(大文字と小文字は区別されません)。全一覧はすべてのコマンドを参照してください。

value — 省略可能。値が必要なコマンドもあります。たとえば forecolor は色を、formatblock は h2 などのタグを受け取ります。

戻り値

コマンドが無効またはブロックされている場合は false。それ以外の場合はコマンドが実行されます。

動作に関する注意

  • コマンド名は大文字と小文字を区別しません。内部で小文字に変換されるので、Bold と bold は同じように動作します。
  • 無効なコマンドはスキップされます。コマンドが現在有効でない場合、execCommand() は何もせずに false を返します。事前に知る必要がある場合は、先に isCommandEnabled() で確認してください。
  • すべてのコマンドは横取りできます。実行前に、エディターは exec_command イベント(とコマンドごとの exec_command_<name> イベント)を発生させます。ハンドラーから値を返すと、組み込みの動作が上書きされます。

使用例

表示のコマンドを切り替えます。

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

値が必要なコマンドを実行します。

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

独自のボタンを書式設定のコマンドに接続します。

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

関連項目