document.execCommand
已弃用: 不再推荐使用该特性。虽然一些浏览器仍然支持它,但也许已从相关的 web 标准中移除,也许正准备移除或出于兼容性而保留。请尽量不要使用该特性,并更新现有的代码;参见本页面底部的兼容性表格以指导你作出决定。请注意,该特性随时可能无法正常工作。
当一个 HTML 文档切换到设计模式时,document
暴露 execCommand
方法,该方法允许运行命令来操纵可编辑内容区域的元素。
大多数命令影响document
的 selection(粗体,斜体等),当其他命令插入新元素(添加链接)或影响整行(缩进)。当使用contentEditable
时,调用 execCommand()
将影响当前活动的可编辑元素。
语法
execCommand(aCommandName, aShowDefaultUI, aValueArgument)
返回值
一个 Boolean
,如果是 false
则表示操作不被支持或未被启用。
备注:在调用一个命令前,不要尝试使用返回值去校验浏览器的兼容性
参数
aCommandName
aShowDefaultUI
-
一个
Boolean
,是否展示用户界面,一般为 false。Mozilla 没有实现。 aValueArgument
-
一些命令(例如 insertImage)需要额外的参数(insertImage 需要提供插入 image 的 url),默认为 null。
命令
backColor
-
修改文档的背景颜色。在 styleWithCss 模式下,则只影响容器元素的背景颜色。这需要一个
<color>
类型的字符串值作为参数传入。注意,IE 浏览器用这个设置文字的背景颜色。 bold
ClearAuthenticationCache
-
清除缓存中的所有身份验证凭据。
contentReadOnly
-
通过传入一个布尔类型的参数来使能文档内容的可编辑性。(IE 浏览器不支持)
copy
-
拷贝当前选中内容到剪贴板。启用这个功能的条件因浏览器不同而不同,而且不同时期,其启用条件也不尽相同。使用之前请检查浏览器兼容表,以确定是否可用。
createLink
-
将选中内容创建为一个锚链接。这个命令需要一个
href
URI 字符串作为参数值传入。URI 必须包含至少一个字符,例如一个空格。(浏览器会创建一个空链接) cut
-
剪贴当前选中的文字并复制到剪贴板。启用这个功能的条件因浏览器不同而不同,而且不同时期,其启用条件也不尽相同。使用之前请检查浏览器兼容表,以确定是否可用。
decreaseFontSize
-
给选中文字加上
<small>
标签,或在选中点插入该标签。(IE 浏览器不支持) defaultParagraphSeparator
-
更改在可编辑文本区域中创建新段落时使用的段落分隔符。有关更多详细信息,请参阅标记生成的差异。
delete
-
删除选中部分。
enableAbsolutePositionEditor
-
启用或禁用允许移动绝对定位元素的抓取器。Firefox 63 Beta/Dev Edition 默认禁用此功能 (Firefox bug 1449564)。
enableInlineTableEditing
-
启用或禁用表格行和列插入和删除控件。(IE 浏览器不支持)
enableObjectResizing
-
启用或禁用图像和其他对象的大小可调整大小手柄。(IE 浏览器不支持)
fontName
-
在插入点或者选中文字部分修改字体名称。需要提供一个字体名称字符串 (例如:"Arial") 作为参数。
fontSize
-
在插入点或者选中文字部分修改字体大小。需要提供一个 HTML 字体尺寸 (1-7) 作为参数。
foreColor
-
在插入点或者选中文字部分修改字体颜色。需要提供一个颜色值字符串作为参数。
formatBlock
-
添加一个 HTML 块式标签在包含当前选择的行,如果已经存在了,更换包含该行的块元素 (在 Firefox 中,BLOCKQUOTE 是一个例外 -它将包含任何包含块元素). 需要提供一个标签名称字符串作为参数。几乎所有的块样式标签都可以使用 (例如。"H1", "P", "DL", "BLOCKQUOTE"). (IE 浏览器仅仅支持标题标签 H1 - H6, ADDRESS,和 PRE,使用时还必须包含标签分隔符 < >, 例如 "<H1>".)
forwardDelete
-
删除光标所在位置的字符。和按下删除键一样。
heading
-
添加一个标题标签在光标处或者所选文字上。需要提供标签名称字符串作为参数(例如:"H1"、"H6")(IE 和 Safari 不支持)
hiliteColor
-
更改选择或插入点的背景颜色。需要一个颜色值字符串作为值参数传递。UseCSS 必须开启此功能。(IE 浏览器不支持)
increaseFontSize
-
在选择或插入点周围添加一个 BIG 标签。(IE 浏览器不支持)
indent
-
缩进选择或插入点所在的行,在 Firefox 中,如果选择多行,但是这些行存在不同级别的缩进,只有缩进最少的行被缩进。
insertBrOnReturn
-
控制当按下 Enter 键时,是插入 br 标签还是把当前块元素变成两个。(IE 浏览器不支持)
insertHorizontalRule
-
在插入点插入一个水平线(删除选中的部分)
insertHTML
-
在插入点插入一个 HTML 字符串(删除选中的部分)。需要一个个 HTML 字符串作为参数。(IE 浏览器不支持)
insertImage
-
在插入点插入一张图片(删除选中的部分)。需要一个 URL 字符串作为参数。这个 URL 图片地址至少包含一个字符。空白字符也可以(IE 会创建一个链接其值为 null)
insertOrderedList
-
在插入点或者选中文字上创建一个有序列表
insertUnorderedList
-
在插入点或者选中文字上创建一个无序列表。
insertParagraph
-
在选择或当前行周围插入一个段落。(IE 会在插入点插入一个段落并删除选中的部分.)
insertText
-
在光标插入位置插入文本内容或者覆盖所选的文本内容。
italic
-
在光标插入点开启或关闭斜体字。 (Internet Explorer 使用 EM 标签,而不是 I )
justifyCenter
-
对光标插入位置或者所选内容进行文字居中。
justifyFull
-
对光标插入位置或者所选内容进行文本对齐。
justifyLeft
-
对光标插入位置或者所选内容进行左对齐。
justifyRight
-
对光标插入位置或者所选内容进行右对齐。
outdent
-
对光标插入行或者所选行内容减少缩进量。
paste
-
在光标位置粘贴剪贴板的内容,如果有被选中的内容,会被替换。剪贴板功能必须在 user.js 配置文件中启用。参阅 [1].
redo
-
重做被撤销的操作。
removeFormat
-
对所选内容去除所有格式
selectAll
-
选中编辑区里的全部内容。
strikeThrough
-
在光标插入点开启或关闭删除线。
subscript
-
在光标插入点开启或关闭下角标。
superscript
-
在光标插入点开启或关闭上角标。
underline
-
在光标插入点开启或关闭下划线。
undo
-
撤销最近执行的命令。
unlink
-
去除所选的锚链接的<a>标签
useCSS
已弃用-
切换使用 HTML tags 还是 CSS 来生成标记。要求一个布尔值 true/false 作为参数。注:这个属性是逻辑上的倒退(例如:use false to use CSS, true to use HTML)。(IE 不支持) 该属性已经废弃,使用 styleWithCSS 代替。
styleWithCSS
-
用这个取代 useCSS 命令。参数如预期的那样工作,i.e. true modifies/generates 风格的标记属性,false 生成格式化元素。
AutoUrlDetect
-
更改浏览器自动链接行为(仅 IE 浏览器支持)
示例
CodePen 中关于 如何使用 如何使用的一个例子。
规范
此特性不属于任何规范,也不再有望被标准化。
浏览器兼容性
BCD tables only load in the browser
参阅
HTMLElement.contentEditable
document.designMode
- Rich-Text Editing in Mozilla
- Scribe's "Browser Inconsistencies" documentation with bugs related to
document.execCommand
.