Class: TFCKEditor

Source Location: /TFCKEditor.php

Class Overview

TTextBox
   |
   --TFCKEditor

TFCKEditor class

Author(s):

Mark Leavy <mark@mlstuff.co.uk>

Version:

v0.3, last update on 2005/04/29 18:00:00

Class Details

[line 77]
TFCKEditor class

TFCKEditor wraps the visual editting functionalities provided by the FCKEditor project http://www.fckeditor.net/.

TFCKEditor displays a WYSIWYG text area on the Web page for user input in the HTML format. The text displayed in the TFCKEditor component is specified or determined by using the Text property.

To enable the visual editting on the client side, set the property EnableVisualEdit to true (which is default value). To set the size of the editor when the visual editting is enabled, set the Width and Height properties instead of Columns and Rows because the latter has no meaning under the situation.

To prevent the text displayed in the component from being modified, set the ReadOnly property to true. (If EnableVisualEdit is set to true, the user will still be able to modify the text on the client side, however the server side text will not be changed. Future version of this component may correct this inconsistency.)

Note, Text is not HTML encoded before it is displayed in the THtmlArea component. If the values for the component come from user input, be sure to validate the values to help prevent security vulnerabilities.

Namespace: System.Web.UI.WebControls

Properties

BasePath, string, default=http://yourhost/js/fckeditor/, kept in viewstate
The URL to js/fckeditor/.
EnableVisualEdit, boolean, default=true, kept in viewstate
Gets or sets whether WYSIWYG editting capability should be enabled.
Toolbar, string, default=Default, kept in viewstate
The FCKEditor toolbar to use (Default or Basic).
Skin, string, default=Default, kept in viewstate
The FCKEditor skin to use (Default, Office2003 or Silver).

Compatibility

The client-side visual editting capability is supported by

Internet Explorer 5.5+ for Windows, Mozilla 1.3+, Mozilla Firefox, Netscape 7.1+ and any other Gecko-based browser. If the browser does not support the visual editting, a traditional textarea will be displayed.

Tags:

version:	v0.3, last update on 2005/04/29 18:00:00
author:	Mark Leavy <mark@mlstuff.co.uk>

[ Top ]

Class Methods

method enableVisualEdit [line 170]

void enableVisualEdit(
boolean
$value)

Sets whether to show WYSIWYG text editor.

Tags:

access:

public

Parameters:

boolean

$value

whether to show WYSIWYG text editor

[ Top ]

method getBasePath [line 88]

string getBasePath(
)

BasePath for fckeditor - default is http://yourhost/js/fckeditor/

Tags:

return:	the fckeditor BasePath.
access:	public

[ Top ]

method getSkin [line 124]

string getSkin(
)

Skin for TFCKEditor - default is Default

Tags:

return:	the TFCKEditor skin.
access:	public

[ Top ]

method getTextMode [line 143]

string getTextMode(
)

Overrides the parent implementation.

TextMode for THtmlArea control is always 'MultiLine'

Tags:

return:	the behavior mode of the THtmlArea component.
access:	public

[ Top ]

method getToolbar [line 106]

string getToolbar(
)

Toolbar for TFCKEditor - default is Default

Tags:

return:	the TFCKEditor toolbar.
access:	public

[ Top ]

method isVisualEditEnabled [line 161]

boolean isVisualEditEnabled(
)

Tags:

return:	whether to show WYSIWYG text editor
access:	public

[ Top ]

method render [line 179]

string render(
)

Renders the HTMLArea

Tags:

return:	the rendering result
access:	public

[ Top ]

method setBasePath [line 97]

void setBasePath(
string
$value)

BasePath for fckeditor - default is http://yourhost/js/fckeditor/

Tags:

access:

public

Parameters:

string

$value

fckeditor BasePath (url to js/fckeditor)

[ Top ]

method setSkin [line 133]

void setSkin(
string
$value)

Skin for TFCKEditor - default is Default

Tags:

access:

public

Parameters:

string

$value

the skin to use (Default , Office2003 or Silver)

[ Top ]

method setTextMode [line 153]

void setTextMode(
string
$value)

Overrides the parent implementation.

TextMode for THtmlArea is always 'MultiLine' and cannot be changed to others.

Tags:

access:

public

Parameters:

string

$value

the text mode

[ Top ]

method setToolbar [line 115]

void setToolbar(
string
$value)

Toolbar for TFCKEditor - default is Default

Tags:

access:

public

Parameters:

string

$value

the toolbar to use (Default or Basic)

[ Top ]

Class Constants

JS_FCKEDITOR = 'js/fckeditor'

[line 82]

Relative path to the FCKeditor javascript files

[ Top ]

Documentation generated on Sat, 30 Apr 2005 00:07:19 +0100 by phpDocumentor 1.3.0RC3