New to Telerik UI for ASP.NET AJAX? Start a free 30-day trial

Definition

Namespace:Telerik.Web.UI

Assembly:Telerik.Web.UI.dll

Syntax:

C#
[EmbeddedSkin("Editor")]
[EmbeddedSkin("Editor", "Default")]
[RequiredCss("Telerik.Web.UI.Skins.Common.fonticons.css", RenderMode.Lightweight, typeof(RadEditor))]
[RequiredCss("Telerik.Web.UI.Skins.Common.fonticons.css", RenderMode.Mobile, typeof(RadEditor))]
[RequiredCss("Telerik.Web.UI.Skins.Common.MaterialRipple.css", RenderMode.Lightweight, typeof(RadButton))]
[RequiredCss("Telerik.Web.UI.Skins.Common.MaterialRipple.css", RenderMode.Mobile, typeof(RadButton))]
[RequiredScript(typeof(ResizeExtender))]
[RequiredScript(typeof(SpellCheckService))]
[RequiredScript(typeof(LayoutBuilderEngine))]
[RequiredScript(typeof(RadEditorScripts))]
[ClientScriptResource("Telerik.Web.UI.RadEditor", "Telerik.Web.UI.Common.Core.js")]
[TelerikToolboxCategory("Data Editing")]
public class RadEditor : RadWebControl, IScriptControl, IControlResolver, IPostBackDataHandler, ISkinnableControl, IControl, IEditableTextControl, ITextControl, INamingContainer

Inheritance: objectRadWebControlRadEditor

Derived Classes: AccessibleRadEditor

Implements: IControlIControlResolverIEditableTextControlINamingContainerIPostBackDataHandlerIScriptControlISkinnableControlITextControl...

Inherited Members RadWebControl.ResolveRenderMode()RadWebControl.CanRenderInMode(RenderModeBrowserAdaptor, RenderMode)RadWebControl.PreferredRenderMode(RenderModeBrowserAdaptor)RadWebControl.GetSkinSuffix()RadWebControl.OnPreRender(EventArgs)RadWebControl.RenderSmartPasteDescriptionAttribute()RadWebControl.ConfigureCombinedScriptFile()RadWebControl.ConfigureCombinedBaseSkinFile()RadWebControl.LoadClientState(Dictionary<string, object>)RadWebControl.SaveClientState()RadWebControl.Render(HtmlTextWriter)RadWebControl.RenderScriptsNoScriptManager(HtmlTextWriter)RadWebControl.RenderDescriptorsNoScriptManager(HtmlTextWriter)RadWebControl.ApplyConditionalRendering(HtmlTextWriter)RadWebControl.RenderClassic(HtmlTextWriter)RadWebControl.RenderLite(HtmlTextWriter)RadWebControl.RenderNative(HtmlTextWriter)RadWebControl.InitializeRenderMode()RadWebControl.DescribeRenderMode(IScriptDescriptor)RadWebControl.DescribeProperty<T>(IScriptDescriptor, string, T, T)RadWebControl.DescribeIDReferenceProperty(IScriptDescriptor, string, string)RadWebControl.DescribeEvent(IScriptDescriptor, string, string)RadWebControl.GetEmbeddedSkinNames()RadWebControl.GetViewScriptReference()RadWebControl.GetViewStateValue<T>(string, T)RadWebControl.RegisterWithScriptManagerRadWebControl.EnableRippleEffectRadWebControl.RuntimeSkinRadWebControl.ResolvedRenderModeRadWebControl.SupportsAdaptiveRenderingRadWebControl.SupportsNativeRenderingRadWebControl.SupportsLightweightRenderingRadWebControl.IsRenderModeSetRadWebControl.RenderingCompatibilityRadWebControl.ClientIDModeRadWebControl.ScriptManagerRadWebControl.RadScriptManagerRadWebControl.RadStyleSheetManagerRadWebControl.RendererRadWebControl.AccessKeyRadWebControl.BackColorRadWebControl.BorderColorRadWebControl.BorderStyleRadWebControl.BorderWidthRadWebControl.CssClassRadWebControl.EnabledRadWebControl.EnableThemingRadWebControl.ForeColorRadWebControl.FontRadWebControl.SkinIDRadWebControl.VisibleRadWebControl.TabIndexRadWebControl.ToolTip...

Constructors

C#
public RadEditor()

Properties

C#
[Bindable(true)]
[Obsolete("This property is now obsolete. Please use the ContentFilters property or the EnableFilter and DisableFilter methods", false)]
public bool AllowScripts { get; set; }
C#
public EditorAnimationSettings AnimationSettings { get; }
C#
[ClientControlProperty]
[Bindable(true)]
public bool AutoResizeHeight { get; set; }
C#
public EditorColorCollection Colors { get; }
C#
[Bindable(true)]
public string Content { get; set; }
C#
public string ContentAreaCssFile { get; set; }
C#
[ClientControlProperty]
public EditorContentAreaMode ContentAreaMode { get; set; }
C#
[ClientControlProperty]
public EditorFilters ContentFilters { get; set; }
C#
public EditorContextMenuCollection ContextMenus { get; }
C#
public EditorCssClassCollection CssClasses { get; }
C#
protected override string CssClassFormatString { get; }

Overrides: RadWebControl.CssClassFormatString

C#
public EditorCssFileCollection CssFiles { get; }
C#
public string DialogHandlerUrl { get; set; }
C#
public RadDialogOpener DialogOpener { get; }
C#
public string DialogsCssFile { get; set; }
C#
public string DialogsScriptFile { get; set; }
C#
public IDplImportProxy DocumentImporter { get; set; }
C#
public FileManagerDialogConfiguration DocumentManager { get; set; }
C#
[ClientControlProperty]
public EditModes EditModes { get; set; }
C#
[ClientControlProperty]
public EditorEditType EditType { get; set; }
C#
[ClientControlProperty]
public string EmptyMessage { get; set; }
C#
public override bool EnableAjaxSkinRendering { get; set; }

Overrides: RadWebControl.EnableAjaxSkinRendering

C#
[ClientControlProperty]
[ClientPropertyName("enableAriaSupport")]
public bool EnableAriaSupport { get; set; }
C#
[ClientControlProperty]
public bool EnableComments { get; set; }
C#
public override bool EnableEmbeddedBaseStylesheet { get; set; }

Overrides: RadWebControl.EnableEmbeddedBaseStylesheet

C#
public override bool EnableEmbeddedScripts { get; set; }

Overrides: RadWebControl.EnableEmbeddedScripts

C#
public override bool EnableEmbeddedSkins { get; set; }

Overrides: RadWebControl.EnableEmbeddedSkins

C#
[ClientControlProperty]
public bool EnableImmutableElements { get; set; }
C#
[Bindable(true)]
public bool EnableResize { get; set; }
C#
public bool EnableTextareaMode { get; set; }
C#
[ClientControlProperty]
public bool EnableTrackChanges { get; set; }
C#
public EditorExportSettings ExportSettings { get; }
C#
public string ExternalDialogsPath { get; set; }
C#
public FileManagerDialogConfiguration FlashManager { get; set; }
C#
public EditorFontCollection FontNames { get; }
C#
public EditorFontSizeCollection FontSizes { get; }
C#
public EditorFormatSetCollection FormatSets { get; }
C#
public EditorHeaderToolCollection HeaderTools { get; }

Height

Unit

C#
public override Unit Height { get; set; }

Overrides: RadWebControl.Height

C#
public ImageManagerDialogConfiguration ImageManager { get; set; }
C#
public virtual EditorImportSettings ImportSettings { get; }
C#
public virtual bool IsInAccessibleMode { get; }
C#
[ClientControlProperty]
[ClientPropertyName("isSkinTouch")]
public bool IsSkinTouch { get; set; }
C#
[ClientControlProperty]
public string Language { get; set; }
C#
public SpellCheckerLanguageCollection Languages { get; }
C#
public EditorLinkCollection Links { get; }
C#
public EditorStrings Localization { get; }
C#
public string LocalizationPath { get; set; }
C#
[ClientControlProperty]
public int MaxHtmlLength { get; set; }
C#
[ClientControlProperty]
public int MaxTextLength { get; set; }
C#
public FileManagerDialogConfiguration MediaManager { get; set; }
C#
public EditorModuleCollection Modules { get; }
C#
[Bindable(true)]
[Obsolete("This property is obsolete. Please, use the NewLineMode property instead.", false)]
public bool NewLineBr { get; set; }
C#
[ClientControlProperty]
public EditorNewLineModes NewLineMode { get; set; }
C#
[ClientControlEvent]
[ClientPropertyName("commandExecuted")]
public virtual string OnClientCommandExecuted { get; set; }
C#
[ClientControlEvent]
[ClientPropertyName("commandExecuting")]
public virtual string OnClientCommandExecuting { get; set; }
C#
[ClientControlEvent]
[ClientPropertyName("domChange")]
public virtual string OnClientDomChange { get; set; }
C#
[ClientControlEvent]
[ClientPropertyName("init")]
public virtual string OnClientInit { get; set; }
C#
[ClientControlEvent]
[ClientPropertyName("inlineEditCompleted")]
public string OnClientInlineEditCompleted { get; set; }
C#
[ClientControlEvent]
[ClientPropertyName("load")]
public virtual string OnClientLoad { get; set; }
C#
[ClientControlEvent]
[ClientPropertyName("modeChange")]
public virtual string OnClientModeChange { get; set; }
C#
[ClientControlEvent]
[ClientPropertyName("pasteHtml")]
public virtual string OnClientPasteHtml { get; set; }
C#
[ClientControlEvent]
[ClientPropertyName("selectionChange")]
public virtual string OnClientSelectionChange { get; set; }
C#
[ClientControlEvent]
[ClientPropertyName("submit")]
public virtual string OnClientSubmit { get; set; }
C#
public EditorParagraphCollection Paragraphs { get; }
C#
[Browsable(false)]
public RadContextMenu RadContextMenu { get; }
C#
public EditorRealFontSizeCollection RealFontSizes { get; }
C#
public override RenderMode RenderMode { get; set; }

Overrides: RadWebControl.RenderMode

C#
[Browsable(false)]
public virtual RadRibbonBar RibbonBar { get; }
C#
public FileManagerDialogConfiguration SilverlightManager { get; set; }
C#
[TypeConverter("Telerik.Web.Design.SkinTypeConverter, Telerik.Web.Design, Version=2026.3.812.462, Culture=neutral, PublicKeyToken=121fae78165ba3d4")]
public override string Skin { get; set; }

Overrides: RadWebControl.Skin

C#
public EditorSnippetCollection Snippets { get; }
C#
public SpellCheckSettings SpellCheckSettings { get; }
C#
[Obsolete("This property is obsolete. Please, use the StripFormattingOptions property instead.", false)]
public EditorStripFormattingOptions StripFormattingOnPaste { get; set; }
C#
[ClientControlProperty]
public EditorStripFormattingOptions StripFormattingOptions { get; set; }
C#
protected override bool SupportsRenderingMode { get; }

Overrides: RadWebControl.SupportsRenderingMode

C#
public EditorSymbolCollection Symbols { get; }
C#
public string TableLayoutCssFile { get; set; }

TagKey

HtmlTextWriterTag

C#
protected override HtmlTextWriterTag TagKey { get; }
C#
public FileManagerDialogConfiguration TemplateManager { get; set; }
C#
[Browsable(false)]
[Bindable(false)]
public string Text { get; set; }
C#
[ClientControlProperty]
[Bindable(true)]
public EditorToolbarMode ToolbarMode { get; set; }
C#
public string ToolProviderID { get; set; }
C#
public EditorToolGroupCollection Tools { get; }
C#
[Bindable(true)]
public string ToolsFile { get; set; }
C#
[ClientControlProperty]
public Unit ToolsWidth { get; set; }
C#
public TrackChangesSettings TrackChangesSettings { get; }
C#
public bool UseRadContextMenu { get; set; }

Width

Unit

C#
public override Unit Width { get; set; }

Overrides: RadWebControl.Width

Methods

C#
public virtual void AcceptTrackChanges()
C#
protected override void AddAttributesToRender(HtmlTextWriter writer)
Parameters:writerHtmlTextWriter

Overrides: RadWebControl.AddAttributesToRender(HtmlTextWriter)

C#
protected virtual void ClearCollections()
C#
protected bool ContainsTool(string name)
Parameters:namestringReturns:

bool

C#
protected override void ControlPreRender()

Overrides: RadWebControl.ControlPreRender()

C#
protected override void CreateChildControls()
C#
protected override IRenderer CreateControlRenderer()
Returns:

IRenderer

Overrides: RadWebControl.CreateControlRenderer()

C#
protected override void DescribeClientEvents(IScriptDescriptor descriptor)
Parameters:descriptorIScriptDescriptor

Overrides: RadWebControl.DescribeClientEvents(IScriptDescriptor)

C#
protected override void DescribeClientProperties(IScriptDescriptor descriptor)
Parameters:descriptorIScriptDescriptor

Overrides: RadWebControl.DescribeClientProperties(IScriptDescriptor)

C#
protected override void DescribeComponent(IScriptDescriptor descriptor)
Parameters:descriptorIScriptDescriptor

Overrides: RadWebControl.DescribeComponent(IScriptDescriptor)

C#
public void DisableFilter(EditorFilters filter)
Parameters:filterEditorFilters
C#
public void EnableFilter(EditorFilters filter)
Parameters:filterEditorFilters
C#
protected void EnsureEditorToolType()
C#
public virtual void EnsureToolsFileLoaded()
C#
public void Export(RadEditorExportTemplate template)
Parameters:templateRadEditorExportTemplate
C#
public void ExportToDocx()
C#
public void ExportToMarkdown()
C#
public void ExportToPdf()
C#
public void ExportToRtf()
C#
public EditorTool FindTool(string name)
Parameters:namestringReturns:

EditorTool

C#
public string GetHtml(EditorStripHtmlOptions stripOptions)
Parameters:stripOptionsEditorStripHtmlOptionsReturns:

string

C#
protected override IEnumerable<ScriptDescriptor> GetScriptDescriptors()
Returns:

IEnumerable<ScriptDescriptor>

Overrides: RadWebControl.GetScriptDescriptors()

C#
protected override IEnumerable<ScriptReference> GetScriptReferences()
Returns:

IEnumerable<ScriptReference>

Overrides: RadWebControl.GetScriptReferences()

C#
public void LoadDocxContent(Stream docxStream)
Parameters:docxStreamStream
C#
public void LoadDocxContent(string docxText)
Parameters:docxTextstring
C#
public void LoadMarkdownContent(Stream markdownStream)
Parameters:markdownStreamStream
C#
public void LoadMarkdownContent(string markdownText)
Parameters:markdownTextstring
C#
protected override bool LoadPostData(string postDataKey, NameValueCollection postCollection)
Parameters:postDataKeystringpostCollectionNameValueCollectionReturns:

bool

Overrides: RadWebControl.LoadPostData(string, NameValueCollection)

C#
public void LoadRtfContent(Stream rtfStream)
Parameters:rtfStreamStream
C#
public void LoadRtfContent(string rtfText)
Parameters:rtfTextstring
C#
protected virtual void LoadToolsFile(bool loadOnlyEmptyCollections)
Parameters:loadOnlyEmptyCollectionsbool
C#
public virtual void LoadToolsFile(XmlDocument doc)
Parameters:docXmlDocument
C#
protected override void LoadViewState(object state)
Parameters:stateobject
C#
protected virtual void OnFileDelete(string fileName)
Parameters:fileNamestring
C#
protected virtual void OnFileUpload(string fileName)
Parameters:fileNamestring
C#
protected override void OnInit(EventArgs e)
Parameters:eEventArgs

Overrides: RadWebControl.OnInit(EventArgs)

C#
protected override void OnLoad(EventArgs e)
Parameters:eEventArgs
C#
protected virtual void OnTextChanged(EventArgs e)
Parameters:eEventArgs
C#
protected override void RaisePostDataChangedEvent()

Overrides: RadWebControl.RaisePostDataChangedEvent()

C#
protected override void RegisterCssReferences()

Overrides: RadWebControl.RegisterCssReferences()

C#
protected override void RegisterScriptControl()

Overrides: RadWebControl.RegisterScriptControl()

C#
protected override void RegisterScriptDescriptors()

Overrides: RadWebControl.RegisterScriptDescriptors()

C#
public virtual void RejectTrackChanges()
C#
public override void RenderBeginTag(HtmlTextWriter writer)
Parameters:writerHtmlTextWriter

Overrides: RadWebControl.RenderBeginTag(HtmlTextWriter)

C#
protected virtual void RenderBottomZone(HtmlTextWriter writer)
Parameters:writerHtmlTextWriter
C#
public override void RenderClientStateField(HtmlTextWriter writer)
Parameters:writerHtmlTextWriter

Overrides: RadWebControl.RenderClientStateField(HtmlTextWriter)

C#
protected override void RenderContents(HtmlTextWriter writer)
Parameters:writerHtmlTextWriter

Overrides: RadWebControl.RenderContents(HtmlTextWriter)

C#
protected virtual void RenderEditModes(HtmlTextWriter writer)
Parameters:writerHtmlTextWriter
C#
public override void RenderEndTag(HtmlTextWriter writer)
Parameters:writerHtmlTextWriter

Overrides: RadWebControl.RenderEndTag(HtmlTextWriter)

C#
protected override object SaveViewState()
Returns:

object

C#
public void SetDocxExportTemplate(RadEditorExportTemplate template)
Parameters:templateRadEditorExportTemplate
C#
public void SetMarkdownExportTemplate(RadEditorExportTemplate template)
Parameters:templateRadEditorExportTemplate
C#
public void SetPaths(string[] paths, EditorFileTypes fileTypes, EditorFileOptions fileOptions)
Parameters:pathsstring[]fileTypesEditorFileTypesfileOptionsEditorFileOptions
C#
public void SetPdfExportTemplate(RadEditorExportTemplate template)
Parameters:templateRadEditorExportTemplate
C#
public void SetRtfExportTemplate(RadEditorExportTemplate template)
Parameters:templateRadEditorExportTemplate
C#
public void SetTrackChangesAdapter(ITrackChangesAdapter adapter)
Parameters:adapterITrackChangesAdapter
C#
protected override void TrackViewState()

Events

C#
public event EditorExportContentEventHandler ExportContent
C#
[SuppressMessage("Microsoft.Design", "CA1009:DeclareEventHandlersCorrectly")]
public event EditorDialogEventHandler FileDelete
C#
[SuppressMessage("Microsoft.Design", "CA1009:DeclareEventHandlersCorrectly")]
public event EditorDialogEventHandler FileUpload
C#
public event EditorImportContentEventHandler ImportContent
C#
public event EventHandler TextChanged
In this article
DefinitionConstructorsRadEditor()PropertiesAllowScriptsAnimationSettingsAutoResizeHeightColorsContentContentAreaCssFileContentAreaModeContentFiltersContextMenusCssClassesCssClassFormatStringCssFilesDialogHandlerUrlDialogOpenerDialogsCssFileDialogsScriptFileDocumentImporterDocumentManagerEditModesEditTypeEmptyMessageEnableAjaxSkinRenderingEnableAriaSupportEnableCommentsEnableEmbeddedBaseStylesheetEnableEmbeddedScriptsEnableEmbeddedSkinsEnableImmutableElementsEnableResizeEnableTextareaModeEnableTrackChangesExportSettingsExternalDialogsPathFlashManagerFontNamesFontSizesFormatSetsHeaderToolsHeightImageManagerImportSettingsIsInAccessibleModeIsSkinTouchLanguageLanguagesLinksLocalizationLocalizationPathMaxHtmlLengthMaxTextLengthMediaManagerModulesNewLineBrNewLineModeOnClientCommandExecutedOnClientCommandExecutingOnClientDomChangeOnClientInitOnClientInlineEditCompletedOnClientLoadOnClientModeChangeOnClientPasteHtmlOnClientSelectionChangeOnClientSubmitParagraphsRadContextMenuRealFontSizesRenderModeRibbonBarSilverlightManagerSkinSnippetsSpellCheckSettingsStripFormattingOnPasteStripFormattingOptionsSupportsRenderingModeSymbolsTableLayoutCssFileTagKeyTemplateManagerTextToolbarModeToolProviderIDToolsToolsFileToolsWidthTrackChangesSettingsUseRadContextMenuWidthMethodsAcceptTrackChanges()AddAttributesToRender(HtmlTextWriter)ClearCollections()ContainsTool(string)ControlPreRender()CreateChildControls()CreateControlRenderer()DescribeClientEvents(IScriptDescriptor)DescribeClientProperties(IScriptDescriptor)DescribeComponent(IScriptDescriptor)DisableFilter(EditorFilters)EnableFilter(EditorFilters)EnsureEditorToolType()EnsureToolsFileLoaded()Export(RadEditorExportTemplate)ExportToDocx()ExportToMarkdown()ExportToPdf()ExportToRtf()FindTool(string)GetHtml(EditorStripHtmlOptions)GetScriptDescriptors()GetScriptReferences()LoadDocxContent(Stream)LoadDocxContent(string)LoadMarkdownContent(Stream)LoadMarkdownContent(string)LoadPostData(string, NameValueCollection)LoadRtfContent(Stream)LoadRtfContent(string)LoadToolsFile(bool)LoadToolsFile(XmlDocument)LoadViewState(object)OnFileDelete(string)OnFileUpload(string)OnInit(EventArgs)OnLoad(EventArgs)OnTextChanged(EventArgs)RaisePostDataChangedEvent()RegisterCssReferences()RegisterScriptControl()RegisterScriptDescriptors()RejectTrackChanges()RenderBeginTag(HtmlTextWriter)RenderBottomZone(HtmlTextWriter)RenderClientStateField(HtmlTextWriter)RenderContents(HtmlTextWriter)RenderEditModes(HtmlTextWriter)RenderEndTag(HtmlTextWriter)SaveViewState()SetDocxExportTemplate(RadEditorExportTemplate)SetMarkdownExportTemplate(RadEditorExportTemplate)SetPaths(string[], EditorFileTypes, EditorFileOptions)SetPdfExportTemplate(RadEditorExportTemplate)SetRtfExportTemplate(RadEditorExportTemplate)SetTrackChangesAdapter(ITrackChangesAdapter)TrackViewState()EventsExportContentFileDeleteFileUploadImportContentTextChanged
Not finding the help you need?
Contact Support