您的位置：首页 → 技术开发 → JAVA Script → xhEditor编辑器的API函数接口列表

xhEditor编辑器的API函数接口列表

时间：2011/1/20 14:40:11来源：本站原创作者：清晨我要评论(0)

API接口示例代码：

var editor=$('#elm1').xheditor({tools:'full',skin:'default'});
editor.focus();
editor.setSource('str')
sHtml=editor.getSource()
editor.appendHTML('<p>aaa</p>')
editor.pasteHTML('<p>aaa</p>')
editor.pasteText('str')
sHtml=editor.formatXHTML('<b>aaa</b>')
editor.toggleSource()
editor.toggleFullscreen()
alert(editor.settings.upImgExt);
editor.settings.upImgExt='txt,doc';

API接口列表：

1、focus：使编辑器获得焦点
无参数

2、setSource：设置编辑器源代码
参数1：要设置的源代码内容，例：'<p>aaa</p>'

3、getSource：返回编辑器格式后的源代码
无参数

4、appendHTML：粘贴HTML内容到编辑器结尾处
参数1：要粘贴的HTML代码，例：'<p>uuu</p>'
注：0.9.5版添加

5、getSelect：返回当前选中的内容
参数1：返回格式，可选'text'返回文本格式，其它所有值都返回HTML格式

6、pasteHTML：粘贴HTML内容到编辑器当前光标处
参数1：要粘贴的HTML代码，例：'<p>uuu</p>'
参数2：是否覆盖粘贴，留空(覆盖粘贴)、true(粘贴在光标选择区域之前)、false(粘贴在光标选择区域之后)

7、pasteText：粘贴文本到编辑器当前光标处
参数1：要粘贴的文本，例：'这里的内容完全原样显示<strong>aaa</strong>'
参数2：是否覆盖粘贴，留空(覆盖粘贴)、true(粘贴在光标选择区域之前)、false(粘贴在光标选择区域之后)

8、formatXHTML：格式化XHTML代码
参数1：需要格式化的HTML代码，例：'<b>aaa</b>'，返回'<strong>aaa</strong>'
参数2：是否代码缩进换行,true(执行缩进格式化),false(不执行缩进格式化),默认为false

9、toggleSource：在源代码模式和编辑模式之间切换
参数1：空(切换),true(显示源代码模式),false(显示编辑模式)

10、toggleFullscreen：在全屏模式和标准大小之间切换
参数1：空(切换),true(显示全屏模式),false(显示标准模式)

11、toggleShowBlocktag：切换块标签显示状态
参数1：空(切换),true(切换为显示块标签),false(切换为不显示块标签)

12、addShortcuts：添加快捷键
参数1：快捷键值，例：'ctrl+enter'
参数2：用户按下快捷键后需要响应的程序代码，例：function(){$('#frmTest').submit();}
说明：允许为某个相同快捷键值重复添加多个响应代码
备注：1.0.0 beta2新添加

13、delShortcuts：删除快捷键
参数1：快捷键值，例：'ctrl+enter'
 
备注：1.0.0 Final新添加

14、exec：立即执行按钮及插件
参数1：工具按钮名称(不区分大小写)，例：Link、img
说明：此函数可以在插件内部或者外部Javascript代码中进行调用

15、showModal：显示模式窗口
参数1：模式窗口的标题title
参数2：模式窗口的内容content
参数3：模式窗口的宽度w
参数4：模式窗口的高度h
参数5：模式窗口关闭时的回调函数onRemove

16、showIframeModal：显示iframe式的模式窗口
参数1：模式窗口的标题
参数2：iframe的地址ifmurl，可使用内置变量：{editorRoot}，代表当前编辑器的根路径，例：{editorRoot}xheditor_plugins/test.html
参数3：提供给目标iframe页面回调用的回调函数，可以在iframe页面中以这样的形式调用：callback('1.gif');
参数4：模式窗口的宽度w
参数5：模式窗口的高度h
参数6：模式窗口关闭时的回调函数onRemove

17、settings：获取或者修改编辑器内部参数
internalScript:是否清除内部代码
inlineScript:是否清除内联代码
internalStyle:是否清除内部样式
inlineStyle:是否清除内联样式
forcePtag:强制使用P标签
upLinkUrl:超链接上传接口地址
upLinkExt:超链接本地上传扩展限制
upImgUrl:图片上传接口地址
upImgExt:图片本地上传扩展限制
upFlashUrl:动画上传接口地址
upFlashExt:动画本地上传扩展限制
upMediaUrl:视频上传接口地址
upMediaExt:视频本地上传扩展限制
beforeSetSource:在设置源代码到编辑器前调用此函数
beforeGetSource:从编辑器返回源代码前调用此函数
focus:编辑器获得焦点时回调此函数
blur:编辑器失去焦点时回调此函数
 
注：修改有效变量仅限以上，其它的变量都仅在编辑器初始化时使用

相关阅读 怎么覆盖xhEditor编辑器自带的默认表情？GB2312编码怎么才能使xhEditor编辑器没有乱码xhEditor能兼容哪些jQuery版本?永恒之柱2AI编辑器使用教程 永恒之柱2如何使用AI编辑器孤岛惊魂5游乐场编辑器怎么用 孤岛惊魂5地图编辑器使用教程最新微信编辑器哪个好 排版侠微信编辑器使用教程cf火线时刻怎么开启 cf火线时刻编辑器使用方法详解《荒神》销量超10万 游戏关卡编辑器即将放出

文章评论

查看所有0条评论>>

发表评论

我来说两句...

提交评论