fckeditor manual

Using FCKeditor with JavaScript

The "JavaScript Integration Module" is the client side option to include FCKeditor in your web pages. It is quite easy to use and configure.

Step 1

Suppose that the editor is installed in the /FCKeditor/ path of your web site. The first thing to do is to include the "JavaScript Integration Module" scripts inside the <HEAD> of your page, just like this:

<script type="text/javascript" src="/FCKeditor/fckeditor.js"></script>

Step 2

Now the FCKeditor class is available and ready to use. There are two ways to create an FCKeditor in you page:

Method 1: The inline method (preferred): Go to the body of your page, in the place you want the editor to be (usually inside a form) and place the following script:

<script type="text/javascript">
   var oFCKeditor = new FCKeditor( 'FCKeditor1' ) ;
  oFCKeditor.Create() ;
</script>

Method 2: The TEXTAREA replacement method: In the "onload" method on your page, add the following code to replace a existing TEXTAREA in the page:

<html>
  <head>
    <script type="text/javascript">
      window.onload = function()
      {
        var oFCKeditor = new FCKeditor( 'MyTextarea' ) ;
        oFCKeditor.ReplaceTextarea() ;
      }
    </script>
  </head>
  <body>
    <textarea id="MyTextarea" name="MyTextarea">This is <b>the</b> initial value.</textarea>
  </body>
</html>

Step 3

The editor is now ready to be used. Just open the page in your browser to see it at work.

The FCKeditor Class

This is the main class used to create an instance of FCKeditor in a web page.

Contructor

FCKeditor( instanceName[, width, height, toolbarSet, value] )

instanceName  The unique name that represents the editor instance.
widththe width of the editor in pixels or percents. (Optional, Default: "100%").
heightthe height of the editor in pixels or percents. (Optional, Default: "200").
toolbarSetthe name of the Toolbar set to use. (Optional, Default: "Default").
valuethe initial value (HTML) of the editor. (Optional)

Example:

var oFCKeditor = new FCKeditor( 'FCKeditor1' ) ;

Properties

InstanceName

The name of the this editor instance.

Width

The width of the editor in pixels or percent. Numeric values are handled as pixels.

Default Value: "100%"

Examples:
oFCKeditor.Width = 400 ; // 400 pixels oFCKeditor.Width = "250" ; // 250 pixels oFCKeditor.Width = "80%" ; // 80 percent

Height

The height of the editor in pixels or percent. Numeric values are handled as pixels.

Default Value: "200"

Examples:
oFCKeditor.Height = 400 ; // 400 pixels oFCKeditor.Height = "250" ; // 250 pixels oFCKeditor.Height = "100%" ; // 100 percent

ToolbarSet

The Toolbar set to use. Refers to the configurations set at the fckconfig.js file.

Default Value: "Default"

Example:
oFCKeditor.ToolbarSet = "MyToolbar" ;

Value

The initial value (the HTML) to show in the editor at startup.

Default Value: <empty>

Example:
oFCKeditor.Value = "<h1>Testing</h1>This is a <b>sample</b>." ;

BasePath

The path used by the editor to find its code base. In other words, the directory where the editors package has been installed in your site.

Default Value: "/fckeditor/"

Example:
oFCKeditor.BasePath = "/Components/FCKeditor/" ;

Remarks:
Avoid using relative paths. It is preferable to set the base path starting from the root (/). Always finish the path with a slash (/).

CheckBrowser

Tells this class instance to check the browser compatibility when rendering the editor.

Default Value: true

Example:
oFCKeditor.CheckBrowser = true ;

Remarks:
 This option could be useful if the check was made at the server side.

DisplayErrors

Tells this class instance to show error messages on errors while rendering the editor.

Default Value: true

Example:
oFCKeditor.DisplayErrors = false ;

Collections

Config[ key ] = value

This collection holds all configurations set in the editor instance.

Example:
oFCKeditor.Config[ "AutoDetectLanguage" ] = false ;
oFCKeditor.Config[ "DefaultLanguage" ] = "pt-BR" ;

Methods

Create()

Builds and outputs the editor in the exact place where its called.

Example:
oFCKeditor.Create() ;

ReplaceTextarea()

Replaces an existing <TEXTAREA> in the page with the FCKeditor instance. The Textarea must has its "id" set to the editor InstanceName. The the "id" is not found, the editor uses the TEXTAREA "name" for the replacement.

Example:
window.onload = function()
{
var oFCKeditor = new FCKeditor( 'MyTextarea ' ) ;
oFCKeditor.ReplaceTextarea() ;
}
...
<textarea id="MyTextarea" name= "MyTextarea">This is <b>the</b> initial value.</textarea>

If you are intended to post the editor contents throw a form (the most obvious use of the editor), you must set the "name" attribute of the TEXTAREA. It is useful, to not get confused, to use the same value used in the "id" attribute.

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值