RadEditor

Gets or sets the value indicating whether the RadEditor will auto-resize its height to match content height

[ClientControlProperty]
[Bindable(true)]
public bool AutoResizeHeight { get; set; }

Property Value:

The default value is false.

Colors

EditorColorCollection

Gets the collection containing the colors to put in the Foreground and Background color dropdowns.

[PersistenceMode(PersistenceMode.InnerProperty)]
public EditorColorCollection Colors { get; }

Property Value:

A StringCollection containing the colors to put in the Foreground and Background color dropdowns. Default is an empty StringCollection.

The contents of this collection will override the default colors available in the Foreground and Background color dropdowns. In order to extend the default set you should add the default colors and the new colors.

Note: Setting this property will affect all color pickers of the RadEditor, including those in the table proprties dialogs.

Example:

cs-api-definition
Private Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs) Handles MyBase.Load
RadEditor1.Colors.Add("Red")
RadEditor1.Colors.Add("Green")
RadEditor1.Colors.Add("Blue")
End Sub
cs-api-definition.skip-repl
private void Page_Load(object sender, EventArgs e)
{
RadEditor1.Colors.Add("Red");
RadEditor1.Colors.Add("Green");
RadEditor1.Colors.Add("Blue");
}

Content

Gets or sets the text content of the RadEditor control inlcuding the HTML markup.

[PersistenceMode(PersistenceMode.InnerProperty)]
[Bindable(true)]
[Themeable(true)]
public string Content { get; set; }

Property Value:

The text content of the RadEditor control including the HTML markup. The default is string.Empty.

The text returned by this property contains HTML markup. If only the text is needed use the Text property.

You can also set the text content of the RadEditor inline between the <Content></Content> tags. In this case setting this property in the code behind will override the inline content.

Example:

cs-api-definition
Private Sub btnSave_Click(sender As Object, e As System.EventArgs)
'HtmlEncode the content of the editor to display the HTML tags
LabelContent.Text = Server.HtmlEncode(RadEditor1.Content);
LabelText.Text = Server.HtmlEncode(RadEditor1.Text);
End Sub
cs-api-definition.skip-repl
private void btnSave_Click(object sender, System.EventArgs e)
{
//HtmlEncode the content of the editor to display the HTML tags
LabelContent.Text = Server.HtmlEncode(RadEditor1.Content);
LabelText.Text = Server.HtmlEncode(RadEditor1.Text);
}

ContentAreaCssFile

EditorContextMenuCollection

Gets or sets a string, containing the location of the content area CSS styles. You need to set this property only if you are using a custom skin.

public string ContentAreaCssFile { get; set; }

Property Value:

The content area CSS file.

ContentAreaMode

EditorContentAreaMode

Gets or sets the rendering mode of the editor content area. When set to Iframe, the content area is a separate document (suitable for CMS solutions or when editing a whole page). When set to Div, the content area is in the main page. The default value is Iframe.

[ClientControlProperty]
public EditorContentAreaMode ContentAreaMode { get; set; }

Property Value:

The rendering mode of the editor content area.

ContentFilters

EditorFilters

Gets or sets a value indicating which content filters will be active when the editor is loaded in the browser.

[ClientControlProperty]
public EditorFilters ContentFilters { get; set; }

Property Value:

The default value is EditorFilters.DefaultFilters.

EditorStripFormattingOptions enum members

Member Description
RemoveScripts This filter removes script tags from the editor content. Disable the filter if you want to insert script tags in the content.
MakeUrlsAbsolute This filter makes all URLs in the editor content absolute (e.g. "http://server/page.html" instead of "page.html"). This filter is DISABLED by default.
FixUlBoldItalic This filter changes the deprecated u tag to a span with CSS style.
IECleanAnchors Internet Explorer only - This filter removes the current page url from all anchor(#) links to the same page.
FixEnclosingP This filter removes a parent paragraph tag if the whole content is inside it.
MozEmStrong This filter changes b to strong and i to em in Mozilla browsers.
ConvertFontToSpan This filter changes deprecated font tags to compliant span tags.
ConvertToXhtml This filter converts the HTML from the editor content area to XHTML.
IndentHTMLContent This filter indents the HTML content so it is more readable when you view the code.
OptimizeSpans This filter tries to decrease the number of nested spans in the editor content.
ConvertCharactersToEntities This filter converts reserved characters to their html entity names.
ConvertInlineStylesToAttributes This filter converts XHTML compliant inline style attributes to Email compliant element attributes.
DefaultFilters The default editor behavior. All content filters except MakeUrlsAbsolute are activated.

Member	Description
RemoveScripts	This filter removes script tags from the editor content. Disable the filter if you want to insert script tags in the content.
MakeUrlsAbsolute	This filter makes all URLs in the editor content absolute (e.g. "http://server/page.html" instead of "page.html"). This filter is DISABLED by default.
FixUlBoldItalic	This filter changes the deprecated u tag to a span with CSS style.
IECleanAnchors	Internet Explorer only - This filter removes the current page url from all anchor(#) links to the same page.
FixEnclosingP	This filter removes a parent paragraph tag if the whole content is inside it.
MozEmStrong	This filter changes b to strong and i to em in Mozilla browsers.
ConvertFontToSpan	This filter changes deprecated font tags to compliant span tags.
ConvertToXhtml	This filter converts the HTML from the editor content area to XHTML.
IndentHTMLContent	This filter indents the HTML content so it is more readable when you view the code.
OptimizeSpans	This filter tries to decrease the number of nested spans in the editor content.
ConvertCharactersToEntities	This filter converts reserved characters to their html entity names.
ConvertInlineStylesToAttributes	This filter converts XHTML compliant inline style attributes to Email compliant element attributes.
DefaultFilters	The default editor behavior. All content filters except MakeUrlsAbsolute are activated.

ContextMenus

Gets the collection containing the context menus displayed in the editor content area.

[PersistenceMode(PersistenceMode.InnerProperty)]
public EditorContextMenuCollection ContextMenus { get; }

CssClasses

EditorCssClassCollection

Gets the collection containing the CSS classes to put in the [Apply CSS Class] dropdown.

[PersistenceMode(PersistenceMode.InnerProperty)]
public EditorCssClassCollection CssClasses { get; }

Property Value:

A NameValueCollection containing the CSS classes to put in the [Apply CSS Class] dropdown. Default is an empty NameValueCollection .

The contents of this collection will override the default CSS classes available in the Apply CSS Class dropdown.

CssFiles

EditorCssFileCollection

Gets a reference to a EditorCssFileCollection that can be used to add external CSS files in the editor content area.

[PersistenceMode(PersistenceMode.InnerProperty)]
public EditorCssFileCollection CssFiles { get; }

Property Value:

A EditorCssFileCollection containing the names of the external CSS files that should be available in the editor's content area.

By default, RadEditor uses the CSS classes available in the current page. However, it can be configured to load external CSS files instead. This scenario is very common for editors integrated in back-end administration areas, which have one set of CSS classes, while the content is being saved in a database and displayed on the public area, which has a different set of CSS classes.

If this property is set the RadEditor loads only the styles defined in the CssFiles collection. The styles defined in the current page are not loaded in the editor content area and the "Apply Class" dropdown.

If you want to load only a subset of the defined classes you can use the CssClasses property.

DialogHandlerUrl

Gets or sets the URL which the AJAX call will be made to. Check the help for more information.

public string DialogHandlerUrl { get; set; }

DialogOpener

RadDialogOpener

A read-only property that returns the DialogOpener instance used in the editor control.

public RadDialogOpener DialogOpener { get; }

DialogsCssFile

Gets or sets the location of a CSS file, that will be added in the dialog window. If you need to include more than one file, use the CSS @import url(); rule to add the other files from the first. This property is needed if you are using a custom skin. It allows you to include your custom skin CSS in the dialogs, which are separate from the main page.

public string DialogsCssFile { get; set; }

DialogsScriptFile

Gets or sets the location of a JavaScript file, that will be added in the dialog window. If you need to include more than one file, you will need to combine the scripts into one first. This property is needed if want to override some of the default functionality without loading the dialog from an external ascx file.

public string DialogsScriptFile { get; set; }

DocumentImporter

IDplImportProxy

Contains the import Rtf/Docx functionality.

public IDplImportProxy DocumentImporter { get; set; }

DocumentManager

Contains the configuration of the DocumentManager dialog.

[PersistenceMode(PersistenceMode.InnerProperty)]
public FileManagerDialogConfiguration DocumentManager { get; set; }

Property Value:

An FileManagerDialogConfiguration instance, containing the configuration of the DocumentManager dialog

EditModes

Gets or sets the value indicating which will be the available EditModes.

[ClientControlProperty]
public EditModes EditModes { get; set; }

EditType

EditorEditType

Gets or sets the value of the edit type of the Editor.

[ClientControlProperty]
public EditorEditType EditType { get; set; }

EmptyMessage

Message that will be shown over the content area when the editor is empty.

[ClientControlProperty]
public string EmptyMessage { get; set; }

EnableAjaxSkinRendering

Gets or sets the value, indicating whether to render the skin CSS files during Ajax requests

public override bool EnableAjaxSkinRendering { get; set; }

Overrides: RadWebControl.EnableAjaxSkinRendering

If EnableAjaxSkinRendering is set to false you will have to register the needed control base CSS file by hand when adding/showing the control with Ajax.

EnableAriaSupport

When set to true enables support for WAI-ARIA

[ClientControlProperty]
[ClientPropertyName("enableAriaSupport")]
public bool EnableAriaSupport { get; set; }

EnableComments

When set to true enables support for entering comments in the editor content

[ClientControlProperty]
public bool EnableComments { get; set; }

EnableEmbeddedBaseStylesheet

Gets or sets the value, indicating whether to render the link to the embedded base stylesheet of the control or not.

public override bool EnableEmbeddedBaseStylesheet { get; set; }

Overrides: RadWebControl.EnableEmbeddedBaseStylesheet

If EnableEmbeddedBaseStylesheet is set to false you will have to register the needed control base CSS file by hand.

EnableEmbeddedScripts

Gets or sets the value, indicating whether to render links to the embedded client scripts or not.

public override bool EnableEmbeddedScripts { get; set; }

Overrides: RadWebControl.EnableEmbeddedScripts

If EnableEmbeddedScripts is set to false you will have to register the needed script files by hand.

EnableEmbeddedSkins

Gets or sets the value, indicating whether to render links to the embedded skins or not.

public override bool EnableEmbeddedSkins { get; set; }

Overrides: RadWebControl.EnableEmbeddedSkins

If EnableEmbeddedSkins is set to false you will have to register the needed CSS files by hand.

EnableImmutableElements

When set to true enables support for immutable HTML elements

[ClientControlProperty]
public bool EnableImmutableElements { get; set; }

EnableResize

Gets or sets the value indicating whether the users will be able to resize the RadEditor control on the client

[Bindable(true)]
public bool EnableResize { get; set; }

Property Value:

The default value is true.

EnableTextareaMode

Gets or sets the value, indicating whether to render the editor as a simple textarea (for compatibility with older browsers).

public bool EnableTextareaMode { get; set; }

If EnableTextareaMode is set to true, the editor will be replaced by a textbox where you can write its HTML. All advanced editor features will be disabled.

EnableTrackChanges

When set to true enables support for tracking changes each time the editor content is modified

[ClientControlProperty]
public bool EnableTrackChanges { get; set; }

ExportSettings

EditorExportSettings

Gets a reference to the EditorExportSettings object that allows you to set the export file properties

[PersistenceMode(PersistenceMode.InnerProperty)]
public EditorExportSettings ExportSettings { get; }

Property Value:

A reference to the EditorExportSettings that allows you to set the export file properties

Use the ExportSettings property to control the export file settings This property is read-only; however, you can set the properties of the EditorExportSettings object it returns. The properties can be set declaratively using one of the following methods:

Place an attribute in the opening tag of the Telerik RadEditor control in the form Property-Subproperty, where Subproperty is a property of the EditorExportSettings object (for example, ExportSettings-FileName).
Nest a <ExportSettings> element between the opening and closing tags of the Telerik RadEditor control.

The properties can also be set programmatically in the form Property.Subproperty (for example, ExportSettings.FileName).

ExternalDialogsPath

Gets or sets a value indicating where the editor will look for its dialogs.

public string ExternalDialogsPath { get; set; }

Property Value:

A relative path to the dialogs location. For example: "~/controls/RadEditorDialogs/".

If specified, the ExternalDialogsPath property will allow you to customize and load the editor dialogs from normal ASCX files.

FlashManager

EditorFormatSetCollection

Contains the configuration of the FlashManager dialog.

[PersistenceMode(PersistenceMode.InnerProperty)]
public FileManagerDialogConfiguration FlashManager { get; set; }

Property Value:

An FileManagerDialogConfiguration instance, containing the configuration of the FlashManager dialog

FontNames

EditorFontCollection

Gets the collection containing the custom font names to put in the Font dropdown.

[PersistenceMode(PersistenceMode.InnerProperty)]
public EditorFontCollection FontNames { get; }

Property Value:

A string collection containing the custom font names to put in the Font dropdown. Default is an empty StringCollection.

The contents of this collection will override the default fonts available in the Font dropdown. In order to extend the default set you should add the default font names and the new font names. The default font names are: Arial, Comic Sans MS, Courier New, Tahoma, Times New Roman, Verdana.

Note: the fonts must exist on the client computer.

Example:

cs-api-definition
Private Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs) Handles MyBase.Load
RadEditor1.FontNames.Add("Arial")
RadEditor1.FontNames.Add("Arial Narrow")
RadEditor1.FontNames.Add("Comic Sans MS")
RadEditor1.FontNames.Add("Courier New")
RadEditor1.FontNames.Add("Tahoma")
RadEditor1.FontNames.Add("Times New Roman")
RadEditor1.FontNames.Add("Verdana")
End Sub
cs-api-definition.skip-repl
private void Page_Load(object sender, EventArgs e)
{
RadEditor1.FontNames.Add("Arial");
RadEditor1.FontNames.Add("Arial Narrow");
RadEditor1.FontNames.Add("Comic Sans MS");
RadEditor1.FontNames.Add("Courier New");
RadEditor1.FontNames.Add("Tahoma");
RadEditor1.FontNames.Add("Times New Roman");
RadEditor1.FontNames.Add("Verdana");
}

FontSizes

EditorFontSizeCollection

Gets the collection containing the custom font sizes to put in the [Size] dropdown.

[PersistenceMode(PersistenceMode.InnerProperty)]
public EditorFontSizeCollection FontSizes { get; }

Property Value:

A string collection containing the custom font sizes to put in the Size dropdown. Default is an empty StringCollection.

The contents of this collection will override the default font sizes available in the [Size] dropdown. In order to extend the default set you should add the default font sizes and the new font sizes. The default font sizes are: 1, 2, 3, 4, 5, 6 and 7.

Note: the minimum font size is 1, the maximum is 7.

Example:

cs-api-definition
Private Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs) Handles MyBase.Load
RadEditor1.FontSizes.Add(2)
RadEditor1.FontSizes.Add(3)
RadEditor1.FontSizes.Add(4)
RadEditor1.FontSizes.Add(5)
RadEditor1.FontSizes.Add(6)
RadEditor1.FontSizes.Add(7)
End Sub
cs-api-definition.skip-repl
private void Page_Load(object sender, EventArgs e)
{
RadEditor1.FontSizes.Add(2);
RadEditor1.FontSizes.Add(3);
RadEditor1.FontSizes.Add(4);
RadEditor1.FontSizes.Add(5);
RadEditor1.FontSizes.Add(6);
RadEditor1.FontSizes.Add(7);
}

FormatSets

Gets the collection containing the format sets to put in the FormatSets dropdown.

[PersistenceMode(PersistenceMode.InnerProperty)]
public EditorFormatSetCollection FormatSets { get; }

Property Value:

An EditorFormatSetCollection containing the format sets to put in the FormatSets dropdown.

The contents of this collection will override the default format sets available in the FormatSets dropdown.

HeaderTools

EditorHeaderToolCollection

Gets the collection containing RadEditor HeaderTools.

[PersistenceMode(PersistenceMode.InnerProperty)]
public EditorHeaderToolCollection HeaderTools { get; }

Height

Unit

Gets or sets the height of the Web server control. The default height is 400 pixels.

public override Unit Height { get; set; }

Overrides: RadWebControl.Height

ImageManager

ImageManagerDialogConfiguration

Contains the configuration of the ImageManager dialog.

[PersistenceMode(PersistenceMode.InnerProperty)]
public ImageManagerDialogConfiguration ImageManager { get; set; }

Property Value:

An ImageManagerDialogConfiguration instance, containing the configuration of the ImageManager dialog

ImportSettings

EditorImportSettings

Gets a reference to the EditorImportSettings object that allows you to set the import Rtf/Docx properties

[PersistenceMode(PersistenceMode.InnerProperty)]
public virtual EditorImportSettings ImportSettings { get; }

Property Value:

A reference to the EditorImportSettings that allows you to set the import Rtf/Docx properties

Use the ImportSettings property to control the import settings This property is read-only; however, you can set the properties of the EditorImportSettings object it returns. The properties can be set declaratively using one of the following methods:

Place an attribute in the opening tag of the Telerik RadEditor control in the form Property-Subproperty, where Subproperty is a property of the EditorImportSettings object (for example, ImportSettings Rtf-ImagesMode="External").
Nest a <ImportSettings> element between the opening and closing tags of the Telerik RadEditor control.

The properties can also be set programmatically in the form Property.Subproperty (for example, ImportSettings.Rtf.ImagesMode).

IsInAccessibleMode

Gets a value indicating whether the editor is being rendered in accessible mode

public virtual bool IsInAccessibleMode { get; }

This propery has no setter. If you wish to enable the accessible editor interface, use the AccessibleRadEditor control instead.

IsSkinTouch

Gets or sets bool value indicating if the Runtime skin is touch.

[ClientControlProperty]
[ClientPropertyName("isSkinTouch")]
public bool IsSkinTouch { get; set; }

Language

SpellCheckerLanguageCollection

Gets or sets a string containing the localization language for the RadEditor UI

[ClientControlProperty]
public string Language { get; set; }

Languages

Gets the collection containing the available languages for spellchecking.

[PersistenceMode(PersistenceMode.InnerProperty)]
public SpellCheckerLanguageCollection Languages { get; }

Property Value:

A NameValueCollection containing the available languages for spellchecking. Default value is empty NameValueCollection.

RadEditor has integrated support for the multi-language mode of RadSpell. When working with content in different languages you can select the proper spellchecking dictionary from a dropdown button on the RadEditor toolbar.

Example:

cs-api-definition
Private Sub Page_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load
RadEditor1.Languages.Add("en-US", "English");
RadEditor1.Languages.Add("fr-FR", "French");
RadEditor1.Languages.Add("de-DE", "German");
End Sub
cs-api-definition.skip-repl
private void Page_Load(object sender, EventArgs e)
{
RadEditor1.Languages.Add("en-US", "English");
RadEditor1.Languages.Add("fr-FR", "French");
RadEditor1.Languages.Add("de-DE", "German");
}

Links

EditorLinkCollection

Gets the collection containing the links to put in the Custom Links dropdown.

[PersistenceMode(PersistenceMode.InnerProperty)]
public EditorLinkCollection Links { get; }

Property Value:

A Link object containing the links to put in the Custom Links dropdown.

The Custom Links dropdown of the RadEditor is a very convenient tool for inserting predefined hyperlinks.

Note: the links can be organized in a tree like structure.

Example:

cs-api-definition
Private Sub Page_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load
'Add the root
RadEditor1.Links.Add("Telerik", "http://www.telerik.com")
'Add the Products node And its children
RadEditor1.Links("Telerik").Add("Products", "http://www.telerik.com/products")
RadEditor1.Links("Telerik")("Products").Add("RadControls", "http://www.telerik.com/radcontrols")
RadEditor1.Links("Telerik")("Products").Add("RadEditor", "http://www.telerik.com/RadEditor")
RadEditor1.Links("Telerik")("Products")("RadEditor").Add("QSF", "http://www.telerik.com/demos/aspnet/Editor/Examples/Default/DefaultCS.aspx")
'Add Purchase, Support And Client.Net nodes
RadEditor1.Links("Telerik").Add("Purchase", "http://www.telerik.com/purchase")
RadEditor1.Links("Telerik").Add("Support", "http://www.telerik.com/support")
RadEditor1.Links("Telerik").Add("Client.Net", "http://www.telerik.com/clientnet")
End Sub
cs-api-definition.skip-repl
private void Page_Load(object sender, EventArgs e)
{
//Add the root
RadEditor1.Links.Add("Telerik", "http://www.telerik.com");
//Add the Products node and its children
RadEditor1.Links["Telerik"].Add("Products", "http://www.telerik.com/products");
RadEditor1.Links["Telerik"]["Products"].Add("RadControls", "http://www.telerik.com/radcontrols");
RadEditor1.Links["Telerik"]["Products"].Add("RadEditor", "http://www.telerik.com/RadEditor");
RadEditor1.Links["Telerik"]["Products"]["RadEditor"].Add("QSF", "http://www.telerik.com/demos/aspnet/Editor/Examples/Default/DefaultCS.aspx");
//Add Purchase, Support and Client.Net nodes
RadEditor1.Links["Telerik"].Add("Purchase", "http://www.telerik.com/purchase");
RadEditor1.Links["Telerik"].Add("Support", "http://www.telerik.com/support");
RadEditor1.Links["Telerik"].Add("Client.Net", "http://www.telerik.com/clientnet");
}

Localization

EditorStrings

The Localization property specifies the strings that appear in the runtime user interface of RadEditor.

public EditorStrings Localization { get; }

LocalizationPath

Gets or sets a value indicating where the editor will look for its .resx localization files. By default these files should be in the App_GlobalResources folder. However, if you cannot put the resource files in the default location or .resx files compilation is disabled for some reason (e.g. in a DotNetNuke environment), this property should be set to the location of the resource files.

public string LocalizationPath { get; set; }

Property Value:

A relative path to the dialogs location. For example: "~/controls/RadEditorResources/".

If specified, the LocalizationPath property will allow you to load the editor localization files from any location in the web application.

MaxHtmlLength

int

Gets or sets the max length (in symbols) of the HTML inserted in the RadEditor. When the value is 0 the property is disabled.

[ClientControlProperty]
public int MaxHtmlLength { get; set; }

MaxTextLength

int

Gets or sets the max length (in symbols) of the text inserted in the RadEditor. When the value is 0 the property is disabled.

[ClientControlProperty]
public int MaxTextLength { get; set; }

MediaManager

Contains the configuration of the MediaManager dialog.

[PersistenceMode(PersistenceMode.InnerProperty)]
public FileManagerDialogConfiguration MediaManager { get; set; }

Property Value:

An FileManagerDialogConfiguration instance, containing the configuration of the MediaManager dialog

Modules

EditorModuleCollection

Gets the list of modules that should be made included in RadEditor.

[PersistenceMode(PersistenceMode.InnerProperty)]
public EditorModuleCollection Modules { get; }

NewLineBr

This property is obsolete. Please, use the NewLineMode property instead.

[Bindable(true)]
[Obsolete("This property is obsolete. Please, use the NewLineMode property instead.", false)]
public bool NewLineBr { get; set; }

Property Value:

true when the RadEditor will insert <br> tag when the [Enter] key is pressed; otherwise false. The default value is true.

Note: this property is intended for use only in Internet Explorer. The gecko-based browsers always insert <BR> tags.

NewLineMode

EditorNewLineModes

Gets or sets the value indicating what element will be inserted when the [Enter] key is pressed.

[ClientControlProperty]
public EditorNewLineModes NewLineMode { get; set; }

OnClientCommandExecuted

Gets or sets a value indicating the client-side event handler that is called after an editor command was executed.

[ClientControlEvent]
[ClientPropertyName("commandExecuted")]
public virtual string OnClientCommandExecuted { get; set; }

Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

If specified, the OnClientCommandExecuted client-side event handler that is called when after an editor command was executed. Two parameters are passed to the handler:

sender, the RadEditor object.
args.

Example:

The following example demonstrates how to use the
<strong>OnClientCommandExecuted</strong> property.

<p>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;script type="text/javascript"&gt;<br />
         function OnClientCommandExecuted(sender, args)<br />
         {<br />
         var editor = sender;<br />
         }<br />
        &lt;/script&gt;
    </div>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;radsld:RadEditor ID="RadWindow1"<br />
         runat= "server"<br />
        <strong>OnClientCommandExecuted="OnClientCommandExecuted"</strong>&gt;<br />
        ....<br />
        &lt;/radsld:RadEditor&gt;
    </div>
</p>

OnClientCommandExecuting

Gets or sets a value indicating the client-side event handler that is called before an editor command starts executing.

[ClientControlEvent]
[ClientPropertyName("commandExecuting")]
public virtual string OnClientCommandExecuting { get; set; }

Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

If specified, the OnClientCommandExecuting client-side event handler is called before a command starts executing. Two parameters are passed to the handler:

sender, the RadEditor object.
args.

This event can be cancelled.

Example:

The following example demonstrates how to use the
<strong>OnClientCommandExecuting</strong> property.

<p>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;script type="text/javascript"&gt;<br />
         function OnClientCommandExecuting(sender, args)<br />
         {<br />
         var editor = sender;<br />
         }<br />
        &lt;/script&gt;
    </div>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;radsld:RadEditor ID="RadEditor1"<br />
         runat= "server"<br />
        <strong>OnClientCommandExecuting="OnClientCommandExecuting"</strong>&gt;<br />
        ....<br />
        &lt;/radsld:RadEditor&gt;
    </div>
</p>

OnClientDomChange

Gets or sets a value indicating the client-side event handler that is called when an editor command has been executed providing the changed Dom element.

[ClientControlEvent]
[ClientPropertyName("domChange")]
public virtual string OnClientDomChange { get; set; }

Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

If specified, the OnClientDomChange client-side event handler is called when an editor command has been executed providing the changed Dom element. Two parameters are passed to the handler:

sender, the RadEditor object.
args.

OnClientInit

Gets or sets a value indicating the client-side event handler that is called when editor starts to load on the client.

[ClientControlEvent]
[ClientPropertyName("init")]
public virtual string OnClientInit { get; set; }

Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

If specified, the OnClientInit client-side event handler is called when editor starts to load on the client. Two parameters are passed to the handler:

sender, the RadEditor object.
args.

Example:

The following example demonstrates how to use the
<strong>OnClientInit</strong> property.

<p>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;script type="text/javascript"&gt;<br />
         function OnClientInit(sender, args)<br />
         {<br />
         var editor = sender;<br />
         }<br />
        &lt;/script&gt;
    </div>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;radsld:RadEditor ID="RadEditor1"<br />
         runat= "server"<br />
        <strong>OnClientInit="OnClientInit"</strong>&gt;<br />
        ....<br />
        &lt;/radsld:RadEditor&gt;
    </div>
</p>

OnClientInlineEditCompleted

The event is fired when the inline editing is completed.

[ClientControlEvent]
[ClientPropertyName("inlineEditCompleted")]
public string OnClientInlineEditCompleted { get; set; }

OnClientLoad

Gets or sets a value indicating the client-side event handler that is called when editor is loaded on the client.

[ClientControlEvent]
[ClientPropertyName("load")]
public virtual string OnClientLoad { get; set; }

Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

If specified, the OnClientLoad client-side event handler is called when editor is loaded on the client. Two parameters are passed to the handler:

sender, the RadEditor object.
args.

Example:

The following example demonstrates how to use the
<strong>OnClientLoad</strong> property.

<p>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;script type="text/javascript"&gt;<br />
         function OnClientLoad(sender, args)<br />
         {<br />
         var editor = sender;<br />
         }<br />
        &lt;/script&gt;
    </div>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;radsld:RadEditor ID="RadEditor1"<br />
         runat= "server"<br />
        <strong>OnClientLoad="OnClientLoad"</strong>&gt;<br />
        ....<br />
        &lt;/radsld:RadEditor&gt;
    </div>
</p>

OnClientModeChange

Gets or sets a value indicating the client-side event handler that is called when the content is submitted.

[ClientControlEvent]
[ClientPropertyName("modeChange")]
public virtual string OnClientModeChange { get; set; }

Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

If specified, the OnClientModeChange client-side event handler is called when the mode of the editor is changing.. Two parameters are passed to the handler:

sender, the RadEditor object.
args.

Example:

The following example demonstrates how to use the
<strong>OnClientModeChange</strong> property.

<p>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;script type="text/javascript"&gt;<br />
         function OnClientModeChange(sender, args)<br />
         {<br />
         var editor = sender;<br />
         }<br />
        &lt;/script&gt;
    </div>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;radsld:RadEditor ID="RadEditor1"<br />
         runat= "server"<br />
        <strong>OnClientModeChange="OnClientModeChange"</strong>&gt;<br />
        ....<br />
        &lt;/radsld:RadEditor&gt;
    </div>
</p>

OnClientPasteHtml

Gets or sets a value indicating the client-side event handler that is called when a dialog is closed, but before its value returned would be pasted into the editor.

[ClientControlEvent]
[ClientPropertyName("pasteHtml")]
public virtual string OnClientPasteHtml { get; set; }

Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

If specified, the OnClientPasteHtml client-side event handler is called when a dialog is closed, but before its value returned would be pasted into the editor. Two parameters are passed to the handler:

sender, the RadEditor object.
args.

Example:

The following example demonstrates how to use the
<strong>OnClientPasteHtml</strong> property.

<p>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;script type="text/javascript"&gt;<br />
         function OnClientPasteHtml(sender, args)<br />
         {<br />
         var editor = sender;<br />
         }<br />
        &lt;/script&gt;
    </div>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;radsld:RadEditor ID="RadEditor1"<br />
         runat= "server"<br />
        <strong>OnClientPasteHtml="OnClientPasteHtml"</strong>&gt;<br />
        ....<br />
        &lt;/radsld:RadEditor&gt;
    </div>
</p>

OnClientSelectionChange

Gets or sets a value indicating the client-side event handler that is called when selection inside editor content area changes

[ClientControlEvent]
[ClientPropertyName("selectionChange")]
public virtual string OnClientSelectionChange { get; set; }

Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

If specified, the OnClientSelectionChange client-side event handler is called when selection inside editor content area changes. Two parameters are passed to the handler:

sender, the RadEditor object.
args.

Example:

The following example demonstrates how to use the
<strong>OnClientSelectionChange</strong> property.

<p>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;script type="text/javascript"&gt;<br />
         function OnClientSelectionChange(sender, args)<br />
         {<br />
         var editor = sender;<br />
         }<br />
        &lt;/script&gt;
    </div>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;radsld:RadEditor ID="RadEditor1"<br />
         runat= "server"<br />
        <strong>OnClientSelectionChange="OnClientSelectionChange"</strong>&gt;<br />
        ....<br />
        &lt;/radsld:RadEditor&gt;
    </div>
</p>

OnClientSubmit

EditorParagraphCollection

Gets or sets a value indicating the client-side event handler that is called when the content is submitted.

[ClientControlEvent]
[ClientPropertyName("submit")]
public virtual string OnClientSubmit { get; set; }

Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

If specified, the OnClientPasteHtml client-side event handler is called when a dialog is closed, but before its value returned would be pasted into the editor. Two parameters are passed to the handler:

sender, the RadEditor object.
args.

Example:

The following example demonstrates how to use the
<strong>OnClientSubmit</strong> property.

<p>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;script type="text/javascript"&gt;<br />
         function OnClientSubmit(sender, args)<br />
         {<br />
         var editor = sender;<br />
         }<br />
        &lt;/script&gt;
    </div>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;radsld:RadEditor ID="RadEditor1"<br />
         runat= "server"<br />
        <strong>OnClientSubmit="OnClientSubmit"</strong>&gt;<br />
        ....<br />
        &lt;/radsld:RadEditor&gt;
    </div>
</p>

Paragraphs

Gets the collection containing the paragraph styles to put in the Paragraph Style dropdown.

[PersistenceMode(PersistenceMode.InnerProperty)]
public EditorParagraphCollection Paragraphs { get; }

Property Value:

A NameValueCollection containing the paragraph styles to put in the Paragraph Style dropdown. Default is an empty NameValueCollection.

The contents of this collection will override the default paragraph styles available in the Paragraph Style dropdown.

Note: RadEditor also supports block format with css class set. See the example below.

Example:

cs-api-definition
Private Sub Page_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load
'Add clear formatting
RadEditor1.Paragraphs.Add("Clear Formatting", "body")
'Add the standard paragraph styles
RadEditor1.Paragraphs.Add("Heading 1", "&lt;h1&gt;")
RadEditor1.Paragraphs.Add("Heading 2", "&lt;h2&gt;")
RadEditor1.Paragraphs.Add("Heading 3", "&lt;h3&gt;")
'Add paragraph style With block Format And css Class
RadEditor1.Paragraphs.Add("Heading 2 Bordered", "&lt;h2 class=\"bordered\"&gt;")
End Sub
cs-api-definition.skip-repl
private void Page_Load(object sender, EventArgs e)
{
//Add clear formatting
RadEditor1.Paragraphs.Add("Clear Formatting", "body");
//Add the standard paragraph styles
RadEditor1.Paragraphs.Add("Heading 1", "&lt;h1&gt;");
RadEditor1.Paragraphs.Add("Heading 2", "&lt;h2&gt;");
RadEditor1.Paragraphs.Add("Heading 3", "&lt;h3&gt;");
//Add paragraph style with block format and css class
RadEditor1.Paragraphs.Add("Heading 2 Bordered", "&lt;h2 class=\"bordered\"&gt;");
}

RadContextMenu

Gets a reference to the RadContextMenu, if the control is enabled in RadEditor.

[Browsable(false)]
public RadContextMenu RadContextMenu { get; }

RealFontSizes

EditorRealFontSizeCollection

Gets the collection containing the custom real font sizes to put in the RealFontSize dropdown.

[PersistenceMode(PersistenceMode.InnerProperty)]
public EditorRealFontSizeCollection RealFontSizes { get; }

Property Value:

A string collection containing the custom real font sizes to put in the RealFontSize dropdown. Default is an empty StringCollection.

The contents of this collection will override the default real font sizes available in the RealFontSize dropdown.

Example:

cs-api-definition
Private Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs) Handles MyBase.Load
RadEditor1.RealFontSizes.Add("8pt")
RadEditor1.RealFontSizes.Add("9pt")
RadEditor1.RealFontSizes.Add("11pt")
RadEditor1.RealFontSizes.Add("13pt")
End Sub
cs-api-definition.skip-repl
private void Page_Load(object sender, EventArgs e)
{
RadEditor1.RealFontSizes.Add("8pt")
RadEditor1.RealFontSizes.Add("9pt")
RadEditor1.RealFontSizes.Add("11pt")
RadEditor1.RealFontSizes.Add("13pt")
}

RenderMode

Specifies the rendering mode of the control. Setting the mode to Lightweight will yield HTML 5/CSS 3 html and css.

public override RenderMode RenderMode { get; set; }

Overrides: RadWebControl.RenderMode

Lightweight rendering mode might change the outlook of the component in some older browsers that don't support CSS3/HTML5.

RibbonBar

RadRibbonBar

Gets a reference to the ribbon bar, when toolbar mode is RibbonBar.

[Browsable(false)]
public virtual RadRibbonBar RibbonBar { get; }

SilverlightManager

Contains the configuration of the SilverlightManager dialog.

[PersistenceMode(PersistenceMode.InnerProperty)]
public FileManagerDialogConfiguration SilverlightManager { get; set; }

Property Value:

An FileManagerDialogConfiguration instance, containing the configuration of the SilverlightManager dialog

Skin

EditorStripFormattingOptions

Gets or sets the skin name for the control user interface.

[TypeConverter("Telerik.Web.Design.SkinTypeConverter, Telerik.Web.Design, Version=2026.3.812.462, Culture=neutral, PublicKeyToken=121fae78165ba3d4")]
public override string Skin { get; set; }

Property Value:

A string containing the skin name for the control user interface. The default is string.Empty.

Overrides: RadWebControl.Skin

If this property is not set, the control will render using the skin named "Default". If EnableEmbeddedSkins is set to false, the control will not render skin.

Snippets

EditorSnippetCollection

Gets the collection containing the snippets to put in the Code Snippet dropdown.

[PersistenceMode(PersistenceMode.InnerProperty)]
public EditorSnippetCollection Snippets { get; }

Property Value:

A NameValueCollection containing the snippets to put in the Code Snippet dropdown. Default is an empty NameValueCollection.

The Code Snippet dropdown is a very convenient tool for inserting predefined chunks of HTML content like signatures, product description templates, custom tables, etc.

The contents of this collection will override the default snippets available in the Code Snippet dropdown.

SpellCheckSettings

Contains the configuration of the spell checker.

[PersistenceMode(PersistenceMode.InnerProperty)]
public SpellCheckSettings SpellCheckSettings { get; }

StripFormattingOnPaste

This property is obsolete. Please, use the StripFormattingOptions property instead.

[Obsolete("This property is obsolete. Please, use the StripFormattingOptions property instead.", false)]
public EditorStripFormattingOptions StripFormattingOnPaste { get; set; }

Property Value:

The default value is EditorStripFormattingOptions.None.

StripFormattingOptions

EditorStripFormattingOptions

Gets or sets the value indicating how the editor should clear the HTML formatting when the user pastes data into the content area.

[ClientControlProperty]
public EditorStripFormattingOptions StripFormattingOptions { get; set; }

Property Value:

The default value is EditorStripFormattingOptions.None.

EditorStripFormattingOptions enum members

Member Description
None Doesn't strip anything, asks a question when MS Word formatting was detected.
NoneSupressCleanMessage Doesn't strip anything and does not ask a question.
MSWord Strips only MSWord related attributes and tags.
MSWordNoFonts Strips the MSWord related attributes and tags and font tags.
MSWordNoMargins Strips the MSWord related attributes and tags and margins
MSWordRemoveAll Strips MSWord related attributes and tags, font tags and font size attributes.
Css Removes style attributes.
Font Removes Font tags.
Span Clears Span tags.
AllExceptNewLines Clears all tags except "br" and new lines (\n) on paste.
All Remove all HTML formatting.

Note: In Gecko-based browsers you will see the mandatory dialog box where you need to paste the content.

Member	Description
None	Doesn't strip anything, asks a question when MS Word formatting was detected.
NoneSupressCleanMessage	Doesn't strip anything and does not ask a question.
MSWord	Strips only MSWord related attributes and tags.
MSWordNoFonts	Strips the MSWord related attributes and tags and font tags.
MSWordNoMargins	Strips the MSWord related attributes and tags and margins
MSWordRemoveAll	Strips MSWord related attributes and tags, font tags and font size attributes.
Css	Removes style attributes.
Font	Removes Font tags.
Span	Clears Span tags.
AllExceptNewLines	Clears all tags except "br" and new lines (\n) on paste.
All	Remove all HTML formatting.

Symbols

EditorSymbolCollection

Gets the collection containing the symbols to put in the Symbols dropdown.

[PersistenceMode(PersistenceMode.InnerProperty)]
public EditorSymbolCollection Symbols { get; }

Property Value:

A SymbolCollection containing the symbols to put in the Symbols dropdown. Default is an empty SymbolCollection.

The contents of this collection will override the default symbols available in the Symbols dropdown.

Note: multiple symbols can be added at once by using the SymbolCollection.Add() method.

Example:

cs-api-definition
Private Sub Page_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load
For i As Integer = 65 To 90
RadEditor1.Symbols.Add(Convert.ToChar(i))
Next
End Sub
cs-api-definition.skip-repl
private void Page_Load(object sender, EventArgs e)
{
for (int i=65; i&lt;=90; i++)
{
RadEditor1.Symbols.Add(Convert.ToChar(i));
}
}

TableLayoutCssFile

Gets or sets a string, containing the location of the CSS styles for table css style layout tool in the TableProperties dialogue.

public string TableLayoutCssFile { get; set; }

Property Value:

The content area CSS file.

TagKey

HtmlTextWriterTag

Gets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers.

protected override HtmlTextWriterTag TagKey { get; }

Overrides: WebControl.TagKey

TemplateManager

Contains the configuration of the TemplateManager dialog.

[PersistenceMode(PersistenceMode.InnerProperty)]
public FileManagerDialogConfiguration TemplateManager { get; set; }

Property Value:

An FileManagerDialogConfiguration instance, containing the configuration of the TemplateManager dialog

Text

Gets the text content of the RadEditor control without the HTML markup.

[Browsable(false)]
[Bindable(false)]
public string Text { get; set; }

Property Value:

The text displayed in the RadEditor without the HTML markup. The default is string.Empty.

The text returned by this property contains no HTML markup. If only the HTML markup in the text is needed use the Html property.

You can set the text content of the RadEditor by using the Html property or inline between its opening and closing tags. In this case setting the Html property in the code behind will override the inline content.

Example:

For an example see the Html property.

ToolbarMode

EditorToolbarMode

Gets or sets the value indicating how the editor toolbar will be rendered and will act on the client

[ClientControlProperty]
[Bindable(true)]
public EditorToolbarMode ToolbarMode { get; set; }

Property Value:

Default Toolbars are rendered around the editor content area.
Floating Toolbars are rendered in a moveable window.
PageTop Toolbars appear on top of page when editor gets focus.
ShowOnFocus Toolbars appear right above the editor when it focus.

Several editors can simulate usage of the same toolbar if this property has the same value everywhere

ToolProviderID

EditorToolGroupCollection

Gets or sets a string containing the ID (will search for both server or client ID) of a client object that should be used as a tool provider.

public string ToolProviderID { get; set; }

This property helps significantly reduce the HTML markup and JSON sent from server to the client when multiple RadEditor objects with the same tools are used on the same page.

The ToolProviderID can be set to the ID of another RadEditor, or to a custom control that implements two clientside methods get_toolHTML and get_toolJSON.

Tools

Gets the collection containing RadEditor tools.

[PersistenceMode(PersistenceMode.InnerProperty)]
public EditorToolGroupCollection Tools { get; }

ToolsFile

Gets or sets a string containing the path to the XML toolbar configuration file.

[Bindable(true)]
public string ToolsFile { get; set; }

This property is provided for backwards compatibility. Please, use either inline toolbar declaration or code-behind to configure the toolbars. To configure multiple RadEditor controls with the same settings you could use either Theme, UserControl with inline declaration, or CustomControl.
Use "~" (tilde) as a substitution of the web-application's root directory.

You can also provide this property with an absolute URL which returns a valid XML toolbar configuration file, e.g. http://MyServer/MyApplication/Tools/MyToolsFile.aspx

ToolsWidth

Unit

Gets or sets the width of the editor's toolbar (should be used when ToolbarMode != Default).

[ClientControlProperty]
public Unit ToolsWidth { get; set; }

TrackChangesSettings

Contains the configuration of the track changes functionality.

[PersistenceMode(PersistenceMode.InnerProperty)]
public TrackChangesSettings TrackChangesSettings { get; }

UseRadContextMenu

Specifies whether the RadContextMenu should be used.

public bool UseRadContextMenu { get; set; }

Width

Unit

Gets or sets the width of the Web server control.

public override Unit Width { get; set; }

Overrides: RadWebControl.Width

Methods

AcceptTrackChanges()

Changes the content of the Editor by accepting the track changes

public virtual void AcceptTrackChanges()

AddAttributesToRender(HtmlTextWriter)

Adds HTML attributes and styles that need to be rendered to the specified HtmlTextWriterTag. This method is used primarily by control developers.

protected override void AddAttributesToRender(HtmlTextWriter writer)

Parameters:writerHtmlTextWriter

A HtmlTextWriter that represents the output stream to render HTML content on the client.

Overrides: RadWebControl.AddAttributesToRender(HtmlTextWriter)

ClearCollections()

protected virtual void ClearCollections()

ControlPreRender()

Executes during the prerender event. We set the tools file and fill the collections with their default values.

protected override void ControlPreRender()

Overrides: RadWebControl.ControlPreRender()

CreateChildControls()

protected override void CreateChildControls()

Overrides: Control.CreateChildControls()

DisableFilter(EditorFilters)

Removes a specific filter from the ContentFilters.

public void DisableFilter(EditorFilters filter)

Parameters:filterEditorFilters

An EditorFilters value

EnableFilter(EditorFilters)

Add a specific filter to the ContentFilters.

public void EnableFilter(EditorFilters filter)

Parameters:filterEditorFilters

An EditorFilters value

EnsureEditorToolType()

protected void EnsureEditorToolType()

EnsureToolsFileLoaded()

Forces the ToolsFile to be parsed and loaded at any given time.

public virtual void EnsureToolsFileLoaded()

Export(RadEditorExportTemplate)

A way to export editor's content by using the provided RadEditorExportTemplate.

public void Export(RadEditorExportTemplate template)

Parameters:templateRadEditorExportTemplate

Object, which implements the RadEditorExportTemplate abstract class.

ExportToDocx()

This method is used to export the editor's content to DOCX format.

public void ExportToDocx()

ExportToMarkdown()

This method is used to export the editor's content to Markdown format.

public void ExportToMarkdown()

ExportToPdf()

This method is used to export the editor's content to PDF format.

public void ExportToPdf()

ExportToRtf()

This method is used to export the editor's content to RTF format.

public void ExportToRtf()

FindTool(string)

Finds the tool with the given name.

public EditorTool FindTool(string name)

Parameters:namestring

The name of the tool to find.

Returns:

EditorTool

GetHtml(EditorStripHtmlOptions)

This method is used to strip comments from the Content of the editor.

public string GetHtml(EditorStripHtmlOptions stripOptions)

Parameters:stripOptionsEditorStripHtmlOptionsReturns:

LoadDocxContent(Stream)

This method is used to convert DOCX content to HTML and loadit in RadEditor.

public void LoadDocxContent(Stream docxStream)

Parameters:docxStreamStream

A Stream object holding the DOCX content to be transformed and loaded.

LoadDocxContent(string)

This method is used to convert DOCX content to HTML and load it in RadEditor.

public void LoadDocxContent(string docxText)

Parameters:docxTextstring

A String object in ASCII encoding holding the DOCX content to be transformed and loaded.

LoadMarkdownContent(Stream)

This method is used to convert Markdown content to HTML and loadit in RadEditor.

public void LoadMarkdownContent(Stream markdownStream)

Parameters:markdownStreamStream

A Stream object holding the Markdown content to be transformed and loaded.

LoadMarkdownContent(string)

This method is used to convert Markdown content to HTML and loadit in RadEditor.

public void LoadMarkdownContent(string markdownText)

Parameters:markdownTextstring

A String object holding the Markdown content to be transformed and loaded.

LoadPostData(string, NameValueCollection)

Executed when post data is loaded from the request

protected override bool LoadPostData(string postDataKey, NameValueCollection postCollection)

Parameters:postDataKeystringpostCollectionNameValueCollectionReturns: