Commands Introduce


Commands

功能 说明 命令 参数 返回值 需要引入文件(*.js)
bold 切换选区文本的粗体样式,若选区闭合(即插入符状态)效果参考word execCommand(cmdName) cmdName="bold" true/false basestyle
查询字体效果 queryCommandState(cmdName) cmdName="bold" 0:不为加粗状态。1:为加粗状态
italic 切换选区文本的斜体样式,若选区闭合(即插入符状态)效果参考word execCommand(cmdName) cmdName="italic" true/false
查询斜体效果 queryCommandState(cmdName) cmdName="italic" 0:不为斜体状态。1:为斜体状态
underline 切换选区文本的下划线样式,若选区闭合(即插入符状态)效果参考word execCommand(cmdName) cmdName="underline" true/false
查询下划线效果 queryCommandState(cmdName) cmdName="underline" 0:不为下划线状态。1:为下划线状态
strikethrough 切换选区文本的删除线样式,若选区闭合(即插入符状态)效果参考word execCommand(cmdName) cmdName="strikethrough" true/false
查询删除线效果 queryCommandState(cmdName) cmdName="strikethrough" 0:不为删除线状态。1:为删除线状态
subscript 切换选区文本的下脚标样式,若选区闭合(即插入符状态)效果参考word execCommand(cmdName) cmdName="subscript" true/false
查询下脚标效果 queryCommandState(cmdName) cmdName="subscript" 0:不为下脚标状态。1:为下脚标状态
superscript 切换选区文本的上脚标样式,若选区闭合(即插入符状态)效果参考word execCommand(cmdName) cmdName="superscript" true/false
查询上脚标效果 queryCommandState(cmdName) cmdName="superscript" 0:不为上脚标状态。1:为上脚标状态
blockquote 给选区内容加引号 execCommand(cmdName) cmdName="blockquote" true/false blockquote
查询内容引号效果 queryCommandState(cmdName) cmdName="blockquote" 0:不为引号状态。1:为引号状态
cleardoc 清空文档 execCommand(cmdName) cmdName="cleardoc" true/false cleardoc
directionality 定义输入方向.forward:ltr从左到右,rtl从右到左 execCommand(cmdName,forward) cmdName="directionality",forward="ltr" true/false directionality
查询输入方向 queryCommandState(cmdName) cmdName="directionality" ltr:从左到右输入,rtl:从右到左输入
elementpath 查找选区路径,level取值范围为小于等于0,0代表从当前节点查找,-1为上一级 execCommand(cmdName,level) cmdName="elementpath" true/false elementpath
返回所有父节点的标签名称 queryCommandState(cmdName) cmdName="elementpath" 返回:父标签名称的数组。
forecolor 设置选区文本的字体颜色(参数值参考css中的color,若参数使用'default'值,则表示去除字体颜色) execCommand(cmdName) cmdName="forecolor" true/false font
查询字体颜色 queryCommandState(cmdName) cmdName="forecolor" 返回字体颜色样式
backcolor 设置选区文本的字体背景颜色(参数值参考css中的color,若参数使用'default'值,则表示去除字体背景颜色) execCommand(cmdName) cmdName="backcolor" true/false
查询字体背景颜色 queryCommandState(cmdName) cmdName="backcolor" 返回字体背景样式
fontsize 设置选区文本的字号大小(参数值参考css中的font-size) execCommand(cmdName) cmdName="fontsize" true/false
查询字体大小 queryCommandState(cmdName) cmdName="fontsize" 返回字体大小样式
fontfamily 设置选区文本的字体样式(参数值参考css中的font-size) execCommand(cmdName) cmdName="fontfamily" true/false
查询字体样式 queryCommandState(cmdName) cmdName="fontfamily" 返回字体样式
horizontal 输入分割线 execCommand(cmdName) cmdName="horizontal" true/false horizontal
查询分割线 queryCommandState(cmdName) cmdName="horizontal" 0:不为分割线。1:为分割线
inserthtml 在插入符位置插入HTML片段(如选区不为空,则会先remove选区内容,若选区跨越了block,则只处理第一个block内的选区) execCommand(cmdName,html) cmdName="inserthtml",html="html代码" true/false inserthtml
justify 将选区或插入符所在段落设置对齐方式.left:居左对齐。right:居右对齐。center:居中对齐。justify:两端对齐 execCommand(cmdName,align) cmdName="justify",align="left" true/false justify
查询格式对齐方式 queryCommandValue(cmdName) cmdName="justify" 返回:left居左,right:居右,center:居中,justify两端对齐
link 将选区作为超链接的文本,参数作为超链接的href值,在选区位置创建一个超链接 execCommand(cmdName) cmdName="link" true/false link
查询是否为链接 queryCommandValue(cmdName) cmdName="link" 返回选区中第一个link节点
unlink 将选区所在的超链接转换为文本 execCommand(cmdName) cmdName="unlink" true/false
查询格式对齐方式 queryCommandState(cmdName) cmdName="unlink" 0:不是链接。1:是链接
insertunorderedlist 在插入符位置插入无序列表(如选区不为空,则会先remove选区内容,若选区跨越了block,则只处理第一个block内的选区)可以指定列表样式(参数值参考list-style-type,默认值是'disc') execCommand(cmdName,style) cmdName="insertunorderedlist",style="disc" true/false list
查询是否为无序列表 queryCommandState(cmdName) cmdName="insertunorderedlist" 0:不是无序列表。1:是无序列表
查询为无序列表的值 queryCommandValue(cmdName) cmdName="insertunorderedlist" 无序列表的节点
insertorderedlist 在插入符位置插入有序列表(如选区不为空,则会先remove选区内容,若选区跨越了block,则只处理第一个block内的选区)可以指定列表样式(参数值参考list-style-type,默认值是'decimal') execCommand(cmdName,style) cmdName="insertorderedlist",style="disc" true/false
查询是否为有序列表 queryCommandState(cmdName) cmdName="insertorderedlist" 0:不是有序列表。1:是有序列表
查询为有序列表的值 queryCommandValue(cmdName) cmdName="insertorderedlist" 有序列表的节点
paragraph 插入段落style可以为p,h1,h2,h3,h4,h5,h6 execCommand(cmdName,style) cmdName="paragraph",style="p" true/false paragraph
查询段落标签 queryCommandValue(cmdName) cmdName="paragraph" 返回标签:比如"p"
preview 预览 execCommand(cmdName) cmdName="preview" true/false preview
print 打印 execCommand(cmdName) cmdName="print" true/false print
removeformat 清除选区文本的格式 execCommand(cmdName) cmdName="removeformat" true/false removeformat
searchreplace 查找替换,opt为对象{replaceStr:替换字符串,all:是否全部替换,casesensitive:是否匹配大小写true为匹配大小写,dir:1为向下查找,-1为向上查找} execCommand(cmdName,opt) cmdName="searchreplace",opt={replaceStr : null,all : false,casesensitive : false,dir : 1} true/false searchreplace
selectall 全选编辑区内容 execCommand(cmdName) cmdName="selectall" true/false selectall
source 查看源码 execCommand(cmdName) cmdName="source" true/false source
查询当前是否为查看源码状态 queryCommandState(cmdName) cmdName="source" 0:不为查看源码状态,1:为查看源码状态
time 插入时间 execCommand(cmdName) cmdName="time" true/false time
date 插入日期 execCommand(cmdName) cmdName="date" true/false time
inserttable 插入表格,tableobj{cellpadding:0,cellspacing:0,width:100,height:100,cellborder:1,border:1,numRows:2,numCols:2} execCommand(cmdName,tableobj) cmdName="inserttable",tableobj={} true/false table
查询当前选区是否为表格 queryCommandState(cmdName) cmdName="inserttable" 0:不在表格里,1:在表格里
deletetable 删除表格 execCommand(cmdName) cmdName="deletetable" true/false
查询当前选区是否为表格 queryCommandState(cmdName) cmdName="deletetable" 0:不在表格里,1:在表格里
mergeright 向右合并单元格 execCommand(cmdName) cmdName="mergeright" true/false
查询右方是否为可合并单元格 queryCommandState(cmdName) cmdName="mergeright" 0:不可合并,1:可合并
mergedown 向下合并单元格 execCommand(cmdName) cmdName="mergedown" true/false
查询下方是否为可合并单元格 queryCommandState(cmdName) cmdName="mergedown" 0:不可合并,1:可合并
deleterow 删除行 execCommand(cmdName) cmdName="deleterow" true/false
查询下方是否为可删除行 queryCommandState(cmdName) cmdName="deleterow" 0:不可删除,1:可删除
deletecol 删除列 execCommand(cmdName) cmdName="deletecol" true/false
查询下方是否为可删除列 queryCommandState(cmdName) cmdName="deletecol" 0:不可删除,1:可删除
splittocells 完全拆分单元格 execCommand(cmdName) cmdName="splittocells" true/false
查询是否可以完全拆分单元格 queryCommandState(cmdName) cmdName="splittocells" 0:不可以,1:可以
splittorows 将单元格拆分成行 execCommand(cmdName) cmdName="splittorows" true/false
查询是否可以将单元格拆分成行 queryCommandState(cmdName) cmdName="splittorows" 0:不可以,1:可以
splittocols 将单元格拆分成列 execCommand(cmdName) cmdName="splittocols" true/false
查询是否可以将单元格拆分成列 queryCommandState(cmdName) cmdName="splittocols" 0:不可以,1:可以
insertrow 插入行 execCommand(cmdName) cmdName="insertrow" true/false
查询是否可以插入行 queryCommandState(cmdName) cmdName="insertrow" 0:不可以,1:可以
insertcol 插入列 execCommand(cmdName) cmdName="insertcol" true/false
查询是否可以插入列 queryCommandState(cmdName) cmdName="insertcol" 0:不可以,1:可以
mergecells 合并多个单元格,通过两个cell将当前包含的所有横纵单元格进行合并 execCommand(cmdName) cmdName="mergecells" true/false
查询选区内容是否为可以合并的单元格 queryCommandState(cmdName) cmdName="mergecells" 0:不可以,1:可以
insertvideo 插入视频 execCommand(cmdName) cmdName="insertvideo" true/false video

Plugins

功能说明构造编辑器时配置参数需要引入文件(*.js)
当输入内容超过编辑器高度时,编辑器会自动增高无autoheight
设置回车标签,默认为brenterTag: "p"enterkey
修复chrome下图片不能点击的问题无fiximgclick
处理特殊键的兼容性问题无keystrokes
可以进行粘贴操作无paste
过滤html标签,rule为对象分为白名单和黑名单,详情请看示例demoserialize:ruleserialize
快捷键无shortcutkeys
对表格操作无table
使编辑器具有前进后退的功能无undo

Remarks

若上表中指出命令需要传参数,则请在调用execCommand时第二个参数给出(和浏览器原生的不太一样),
若上表指出命令参数有默认值,则可以不用传第二个参数。
对于上表中未列出的command会自动调用浏览器原生的execComand处理