Xheditor/初始化參數(shù)列表

初始化參數(shù)示例代碼：

$('#elm1').xheditor({tools:'full',skin:'default',showBlocktag:true,internalScript:false,internalStyle:false,width:300,height:200,loadCSS:'http://xheditor.com/test.css',fullscreen:true,sourceMode:true,forcePtag:true,upImgUrl:"upload.php",upImgExt:"jpg,jpeg,gif,png"});

初始化參數(shù)列表：

• tools：自定義工具按鈕

參數(shù)值：full(完全),mfull(多行完全),simple(簡單),mini(迷你) 或者自定義字符串，例如：'Cut,Copy,Paste,Pastetext,|,Source,Fullscreen,About'

• skin：皮膚風(fēng)格選擇

參數(shù)值：default(默認風(fēng)格),o2007blue(Office 2007 藍色),o2007silver(Office 2007 銀色),vista(Vista),nostyle(NoStyle)

• layerShadow：陰影的深度(按鈕面板和模式窗口的背景陰影)

參數(shù)值：0(不顯示陰影),大于0的數(shù)值(顯示陰影并設(shè)置陰影的深度)

• clickCancelDialog：點擊任意位置取消按鈕面板功能

參數(shù)值：默認true(開啟點擊取消功能),false(關(guān)閉點擊取消功能，必需要點擊“取消”按鈕才能關(guān)閉按鈕面板)

• showBlocktag：顯示段落標簽

參數(shù)值：true(顯示段落標簽),false(不顯示)

• linkTag：樣式鏈接link標簽保留狀態(tài)

參數(shù)值：true(保留樣式鏈接link標簽),false(清理樣式鏈接link標簽)

• internalScript：內(nèi)部JS代碼保留狀態(tài)

參數(shù)值：true(保留內(nèi)部JS代碼),false(清理內(nèi)部JS代碼)

• inlineScript：內(nèi)聯(lián)JS代碼保留狀態(tài)

參數(shù)值：true(保留內(nèi)聯(lián)JS代碼),false(清理內(nèi)聯(lián)JS代碼)

• internalStyle：內(nèi)部樣式保留狀態(tài)

參數(shù)值：true(保留內(nèi)部樣式),false(清理內(nèi)部樣式)

• inlineStyle：內(nèi)聯(lián)樣式保留狀態(tài)

參數(shù)值：true(保留內(nèi)聯(lián)樣式),false(清理內(nèi)聯(lián)樣式)

• width：編輯器寬度

參數(shù)值：不帶單位的數(shù)字，例：300

• height：編輯器高度

參數(shù)值：不帶單位的數(shù)字，例：100

• background：編輯器背景

參數(shù)值：字符串，例：url(test.gif) no-repeat，設(shè)置編輯器背景，格式同CSS同名參數(shù)一致。建議直接設(shè)置textarea的css背景 備注：v1.1.1新添加

• loadCSS：加載樣式

參數(shù)值：URL地址、URL數(shù)組以及直接內(nèi)部樣式，例如：'1.css'、['1.css','2.css']、'<style>body{font-size:20px;}</style>'
備注：1.0.0 RC3新添加加載內(nèi)部樣式功能

• fullscreen：默認全屏顯示

參數(shù)值：true(全屏大小),false(標準大小)

• sourceMode：默認源代碼模式

參數(shù)值：true(源代碼模式),false(編輯模式)

• forcePtag：強制P標簽

參數(shù)值：true(強制使用P標簽),false(不強制),默認true

• cleanPaste：是否清理粘貼的HTML代碼

參數(shù)：0(不做任何清理),1(簡單清理Word),2(深入清理Word),3(強制轉(zhuǎn)文本),默認為2深入清理Word

說明：若網(wǎng)站應(yīng)用需要保留更多的Word樣式效果，請設(shè)置此值為1，不過產(chǎn)生的HTML代碼體積會大大增大

備注：1.1.4版本中新變更，原為wordDeepClean和forcePasteText兩個參數(shù)

• disableContextmenu：禁用編輯區(qū)的右鍵菜單

參數(shù)值：true(禁用右鍵菜單),false(不禁用),默認false 備注：v1.1.0新添加

• editorRoot：編輯器JS文件所在的根路徑

參數(shù)值：編輯器所在的根路徑，用在某些特殊情況下定位編輯器的根路徑，默認為空，讀取默認的編輯器根路徑 備注：v1.1.0新添加

• shortcuts：自定義鍵盤快捷方式

參數(shù)：快捷鍵對應(yīng)事件代碼的對象數(shù)組

示例：{'ctrl+enter':function(){$('#frmTest').submit();}}

備注：1.0.0 beta2新添加

• urlBase：相對URL地址的基地址

參數(shù)：字符串的URL地址，用以解決前后臺不在同一路徑的資源定位問題 備注：1.1.0新添加

• urlType：本地URL地址強制轉(zhuǎn)換方式選擇

參數(shù)：abs(絕對路徑),root(根路徑),rel(相對路徑) 備注：1.0.0 beta2新添加,v1.1.0版中名字由localUrl變更為urlType

• emotPath：修改表情圖片的URL根路徑

參數(shù)：字符串的URL地址，默認為空，指向編輯器路徑下的默認表情 備注：1.1.0新添加

• emotMark：是否在表情img標簽上標注emot屬性

參數(shù)：true(標注),false(不標注),默認為false

說明：若使用了ubb插件，請設(shè)置此屬性為true

備注：1.0.0 beta2新添加

• emots：添加自定義表情

參數(shù)：可定義多個JSON對象數(shù)組，示例如下：{qq:{name:'QQ',count:55,width:25,height:25,line:11},msn:{name:'MSN',count:40,width:22,height:22,line:8}}

1. name：表情分組名
2. count：表情數(shù)量
3. list：表情列表，例：{test1:'表情1',test2:'表情2'}，鍵名代表文件名，擴展名必需為gif，鍵值代表alt信息
4. width：單個表情區(qū)域?qū)挾龋匦璐笥诨虻扔诒砬樽畲髮挾?/li>
5. height：單表情區(qū)域高度，必需大于或等于表情最大高度
6. line：單行顯示表情數(shù)量
7. 說明：count和list必需選其中一個值，注意count模式插入表情img的alt為空

備注：1.0.0 beta2新添加

• hoverExecDelay：懸停自動執(zhí)行延遲的時間

參數(shù)：數(shù)值(單位毫秒)，默認為100，設(shè)置為-1關(guān)閉此功能 備注：1.0.0 rc2新添加

• defLinkText：超鏈接的默認文字

參數(shù)值：字符串(默認值：“點擊打開鏈接”) 說明：只在不選擇任何內(nèi)容的情況下才會用到這個參數(shù)值

• modalWidth：showModal彈出窗口的默認寬度

參數(shù)值：數(shù)值，默認為350 說明：彈出窗口的默認寬度

• modalHeight：showModal彈出窗口的默認高度

參數(shù)值：數(shù)值，默認為220 說明：彈出窗口的默認高度

• modalTitle：showModal彈出窗口是否顯示上方的標題欄

參數(shù)值：true(顯示),false(不顯示）

說明：控制彈出窗口是否顯示上方的標題欄，默認為顯示，若需要顯示一個更定制個性化的iframe窗口，可通過此參數(shù)隱藏上方的標題欄

• upBtnText：上傳按鈕的文字

參數(shù)值：任意字符串,默認值：“上傳” 備注：1.0.0 beta2新添加

• html5Upload：是否開啟HTML5上傳支持

參數(shù)值：true(允許),false(不允許),默認為true允許

說明：本功能需要瀏覽器支持HTML5上傳

備注：1.0.0 Final新添加

• upMultiple：允許一次上傳多少個文件

參數(shù)值：大于0的數(shù)值,默認：99,設(shè)置為1關(guān)閉多文件上傳

說明：本功能需要瀏覽器支持HTML5上傳

備注：1.0.0 RC3新添加

• upLinkUrl：超鏈接文件上傳接收URL

參數(shù)值：接收用戶上傳的服務(wù)器端程序URL，默認留空為禁用超鏈接上傳功能，具體使用方法請參考demo8演示文件

注：可使用內(nèi)置變量：{editorRoot}，代表當前編輯器的根路徑，例：{editorRoot}upload.php

• upLinkExt：超鏈接上傳前限制本地文件擴展名

參數(shù)值：超鏈接上傳前限制的文件擴展名列表，默認為：zip,rar,txt，建議與服務(wù)端擴展名檢查列表一致

• upImgUrl：圖片文件上傳接收URL

參數(shù)值：接收用戶上傳的服務(wù)器端程序URL，默認留空為禁用上傳功能，具體使用方法請參考demo8演示文件

注：可使用內(nèi)置變量：{editorRoot}，代表當前編輯器的根路徑，例：{editorRoot}upload.php

• upImgExt：圖片上傳前限制本地文件擴展名

參數(shù)值：圖片上傳前限制的文件擴展名列表，默認為：jpg,jpeg,gif,png，建議與服務(wù)端擴展名檢查列表一致

• upFlashUrl：動畫文件上傳接收URL

參數(shù)值：接收用戶上傳的服務(wù)器端程序URL，默認留空為禁用上傳功能，具體使用方法請參考demo8演示文件

注：可使用內(nèi)置變量：{editorRoot}，代表當前編輯器的根路徑，例：{editorRoot}upload.php

• upFlashExt：動畫上傳前限制本地文件擴展名

參數(shù)值：動畫上傳前限制的文件擴展名列表，默認為：swf，建議與服務(wù)端擴展名檢查列表一致

• upMediaUrl：視頻文件上傳接收URL

參數(shù)值：接收用戶上傳的服務(wù)器端程序URL，默認留空為禁用上傳功能，具體使用方法請參考demo8演示文件

注：可使用內(nèi)置變量：{editorRoot}，代表當前編輯器的根路徑，例：{editorRoot}upload.php

• upMediaExt：視頻上傳前限制本地文件擴展名

參數(shù)值：視頻上傳前限制的文件擴展名列表，默認為：avi，建議與服務(wù)端擴展名檢查列表一致

• onUpload：文件上傳成功回調(diào)函數(shù)

參數(shù)值：成功后需要執(zhí)行的函數(shù)

說明：這個函數(shù)執(zhí)行時返回的值為上傳程序返回的msg變量，可能為字符串或者數(shù)組，若為字符串則直接代表url，若是數(shù)組，則必需包含一個url的變量，其它可由可開發(fā)者自定義

備注：1.0.0 beta2新添加

• plugins：自定義按鈕之插件擴展

插件對象的屬性解釋：

1. c：樣式表名稱
2. t：插件名字(鼠標在按鈕上方時顯示)
3. s：快捷方式，例："ctrl+enter"
4. h：是否鼠標懸停直接執(zhí)行,1:直接執(zhí)行(省略當前值代表不直接執(zhí)行)
5. e：按鈕點擊后需要執(zhí)行的代碼(省略執(zhí)行代碼，則把當前的插件名作為參數(shù)，調(diào)用瀏覽器的execCommand函數(shù))

特別說明：

如果您希望樣式表存儲在系統(tǒng)自帶的模板目錄ui.css中，請將插件對象的樣式名留空，則會自動按照插件名來調(diào)用相應(yīng)的樣式，例如：xhEdtBtnCut、xhEdtBtnCopy，其中的Cut和Copy是插件名

具體調(diào)用方法請參考演示文件夾中的demo9

• submitID：觸發(fā)表單提交的按鈕ID值

參數(shù)值：表單提交按鈕的ID值，默認在form表單上綁定submit以同步結(jié)果

說明：通過本參數(shù)，在非標準submit提交環(huán)境下，比如AJAX提交，可以由用戶點擊提交按鈕以觸發(fā)編輯器最新值的同步

備注：v1.1.7新添加

• onPaste：剪切板粘貼回調(diào)函數(shù)

參數(shù)值：用戶粘貼后需要執(zhí)行的函數(shù)

說明：此函數(shù)用來過濾用戶粘貼的代碼，若返回false禁用粘貼

備注：v1.1.8新添加

• localUrlTest：非本站域名測試正則表達式

參數(shù)值：正則表達式

說明：本參數(shù)用來測試某些組件中測試URL是否屬于本站域名

備注：v1.1.8新添加

• remoteImgSaveUrl：遠程圖片抓取接收程序URL

參數(shù)值：字符串(若不設(shè)置不開啟此功能)

說明：當localUrlTest測試為false時，會將圖片URL發(fā)往當前參數(shù)指定的服務(wù)器端上傳接收程序，抓取成功后將本地URL返回并替換

備注：v1.1.8新添加

• readTip：無障礙讀屏提示

參數(shù)值：字符串(默認為空)

說明：無障礙讀屏軟件提示文字，可用來為殘疾人士提示快捷鍵等信息

備注：v1.1.9新添加

參考來源

• http://xheditor.com/manual/2

Xheditor使用手冊導(dǎo)航
入門基礎(chǔ) 進階使用： 進階使用指導(dǎo)|初始化參數(shù)列表|API函數(shù)接口列表|上傳程序開發(fā)規(guī)范|插件開發(fā)指南|皮膚設(shè)計指南 其它相關(guān)