← 全部文档

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");
};

相关内容