The Editor type exposes the following members.

Properties

  Name Description
Public property AccessKey
Gets or sets the access key that allows you to quickly navigate to the Web server control.
(Inherited from WebControl.)
Protected property Adapter
Gets the browser-specific adapter for the control.
(Inherited from Control.)
Public property AjaxPostbackUrl
Specify a URL to process editor ajax requests and upload requests.
Public property AllowScriptCode
Specifies whether to strip all script elements and script contents from the html to prevent javaScript injection. When this property is set to false (the default) Rich Text Editor strips all script elements and script contents from the html.
Public property AppRelativeTemplateSourceDirectory
Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control.
(Inherited from Control.)
Public property AttrBlackList
The editor HTML Filter allows you to accept HTML input from your users, filter it to make sure it contains only an allowed set of tags, attributes and values and then display it without leaving yourself open to XSS holes. AttrBlackList property allows you set a list of html attributes that will be removed from content sources.
Public property Attributes
Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control.
(Inherited from WebControl.)
Public property AttrWhiteList
The editor HTML Filter allows you to accept HTML input from your users, filter it to make sure it contains only an allowed set of tags, attributes and values and then display it without leaving yourself open to XSS holes. AttrWhiteList property allows you set a list of html attributes that will not be removed from content sources.
Public property AutoFocus
Specifies whether the editor grabs focus when the page loads. If this property is set to true then the editor will take focus, if it is set to false it will not.
Public property AutoParseClasses
Specifies whether or not the RichTextEditor should automatically parse the CSS classes from ContentCss and populate all items into CssClass dropdown
Public property BackColor
Gets or sets the background color of the Web server control.
(Inherited from WebControl.)
Public property BaseHref
Sets or retrieves the baseline URL on which relative links will be based.
Public property BBCode
Gets or sets the bbcode contents of RichTextEditor.
Public property BindingContainer
Gets the control that contains this control's data binding.
(Inherited from Control.)
Public property BorderColor
Gets or sets the border color of the Web control.
(Inherited from WebControl.)
Public property BorderStyle
Gets or sets the border style of the Web server control.
(Inherited from WebControl.)
Public property BorderWidth
Gets or sets the border width of the Web server control.
(Inherited from WebControl.)
Public property BrowserType
Gets the browser type as detected by the HTTP headers sent by the browser.
Protected property ChildControlsCreated
Gets a value that indicates whether the server control's child controls have been created.
(Inherited from Control.)
Public property ClientFolder
Sets the path where you want to store the editor client script files.
Public property ClientID
Gets the server control identifier generated by ASP.NET.
(Inherited from Control.)
Protected property ClientIDSeparator
Gets a character value representing the separator character used in the ClientID property.
(Inherited from Control.)
Public property ContentCss
Specifies the location of the style sheet that will be used by the editable area. Multiple Style Sheets are supported. Example ContentCss="example.css,~/portal.css,/default.css"
Public property ContentCssText
Gets or sets inline CSS text that will be used by the editable area. Example ContentCssText=" p{font:Normal 12px 'Segoe UI'} .exampleclass{font-weight: bold}"
Protected property Context
Returns the current HTTP context.
Public property ContextMenuMode
Determines the appearance and behavior of menus associated with the Context menu.
Public property Controls
Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy.
(Inherited from Control.)
Public property ControlStyle
Gets the style of the Web server control. This property is used primarily by control developers.
(Inherited from WebControl.)
Public property ControlStyleCreated
Gets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers.
(Inherited from WebControl.)
Public property CssClass
Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client.
(Inherited from WebControl.)
Public property DesignDocType
Defines which version of HTML that RichTextEditor uses in the editor content area.
Protected property DesignMode
Gets a value indicating whether a control is being used on a design surface.
(Inherited from Control.)
Public property DisableClassList
The class items in the style dropdown needed to be disabled going to this string. Example DisableClassList="BreadCrumb, TopicMenu, Footer"
Public property DisabledItems
The toolbar items needed to be disabled going to this string. Example DisabledItems="Bold, New, Delete"
Public property DisableStaticLinks
There is an arrow button right to the insert link button. When users click this arrow button, the internal links treeview will display. The internal links is a convenient tool for inserting pre-defined hyperlinks. It can be used to display the internal links of the website or frequently used links. You can create a custom links treeview programmatically or by modifying the richtexteditor\config\staticlinks.xml. If you want to disable the internal links treeview, you can use set this property to true.
Public property DisableStaticTemplates
There is an arrow button right to the insert template button. When users click this arrow button, the code snippet treeview will display. The code snippet is a convenient tool for displaying a predefined set of code snippets. You can create a code snippet treeview programmatically or by modifying the richtexteditor\config\statictemplates.xml. If you want to disable the code snippet treeview, you can use set this property to true.
Public property EditCompleteDocument
Specifies whether a complete HTML document is being edited.
Public property EditorBodyClass
Specifies the Class name that will be added to the body of the editor document.
Public property EditorBodyId
Specifies an Id name that will be added to the body of the editor document.
Public property EditorBodyStyle
Specifies the css style that will be applied to the body of the editor document.
Public property EditorMode
Determines which mode (Edit/Code/View) the editor is in.
Public property EnableAntiSpamEmailEncoder
Email contact links are an invaluable part of any web page. However, they are also vulnerable to a particular type of web robot known as the spam harvester or spambot. A spam harvester can read through the pages in your site and extract email addresses which are then added to bulk marketing databases. RichTextEditor allows you reduce possible spam by 'disguising' a raw email address in an encoded ASCII form.. You can turn this feature off by setting this property to "false".
Public property EnableContextMenu
Gets or sets a value indicating whether to display the context menu, which appears when the right mouse button is clicked.
Public property Enabled
Gets or sets a value indicating whether the Web server control is enabled.
(Inherited from WebControl.)
Public property EnableDragDrop
Enables or disables drag-and-drop support for the editor.
Public property EnableIEBorderRadius
Gets or sets a value indicating whether to render the rounded corners using border-radius in IE.
Public property EnableMimetypeChecking
By default RichTextEditor automatically detect the MIME type of the files you upload, and rejects the file if the file-extension does not match the mime type ("The file is corrupt or has an incorrect extension"). You can turn it off by setting this property to "false".
Public property EnableObjectResizing
Specifies whether or not to allow the users resize an object winthin the RichTextEditor. For example, if you want to prevent people from resizing images, table winthin the RichTextEditor, you can set it to false.
Public property EnableTheming
Gets or sets a value indicating whether themes apply to this control.
(Inherited from WebControl.)
Public property EnableViewState
Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client.
(Inherited from Control.)
Public property EncodeHiddenValue
By default Rich Text Editor will encode the value in the Hidden field automatically. You can turn it off by setting this property to "false". If this property is set to false, ValidateRequest="false" in the page directive is required.
Public property EnterKeyTag
Specifies the behavior when the "enter" key is pressed in the editor.
Protected property Events
Gets a list of event handler delegates for the control. This property is read-only.
(Inherited from Control.)
Public property Font
Gets the font properties associated with the Web server control.
(Inherited from WebControl.)
Public property ForeColor
Gets or sets the foreground color (typically the color of the text) of the Web server control.
(Inherited from WebControl.)
Public property FullScreen
Gets or sets whether the RichTextEditor control is used in a full-screen mode.
Public property HasAttributes
Gets a value indicating whether the control has attributes set.
(Inherited from WebControl.)
Protected property HasChildViewState
Gets a value indicating whether the current server control's child controls have any saved view-state settings.
(Inherited from Control.)
Public property Height
Gets or sets the height of the Web server control.
(Inherited from WebControl.)
Public property ID
Gets or sets the programmatic identifier assigned to the server control.
(Inherited from Control.)
Protected property IdSeparator
Gets the character used to separate control identifiers.
(Inherited from Control.)
Protected property IsChildControlStateCleared
Gets a value indicating whether controls contained within this control have control state.
(Inherited from Control.)
Protected property IsEnabled
Gets a value indicating whether the control is enabled.
(Inherited from WebControl.)
Protected property IsMvcMode
This property returns true if the editor is running in Mvc mode
Protected property IsTrackingViewState
Gets a value that indicates whether the server control is saving changes to its view state.
(Inherited from Control.)
Protected property IsViewStateEnabled
Gets a value indicating whether view state is enabled for this control.
(Inherited from Control.)
Public property Language
This property sets the user interface language localization to use.. If left empty, the editor will automatically be localized to the user language settings from the clients browser Page.Request.UserLanguages[0] ,
Public property LinkGroupArray
An array of link groups which will be displayed in internal links treeview as treenode.
Public property LinkItemArray
An array of predefined hyperlinks which will be displayed in internal links treeview as treeitem.
Public property LinkUrlArray
An array of xml files. Those xml files should contain predefined set of hyperlinks which will be displayed in the internal links treeview. editor.LinkUrlArray = new string[] { "mylinks.xml"};
Public property LoadDelay
Gets or sets the delay, in milliseconds, before the editor loading operation is started.
Protected property LoadViewStateByID
Gets a value indicating whether the control participates in loading its view state by ID instead of index.
(Inherited from Control.)
Public property MaxHTMLLength
Gets or sets the maximum number of characters including the HTML tags allowed in the RichTextEditor. Default is -1, indicating no maximum.
Public property MaxTextLength
Gets or sets the maximum number of characters excluding the HTML tags allowed in the RichTextEditor. Default is -1, indicating no maximum.
Protected property MvcContext
Returns the current HTTP context.
Public property Name
Gets or sets the name of the editor control.
Public property NamingContainer
Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same ID property value.
(Inherited from Control.)
Public property Page
Gets a reference to the Page instance that contains the server control.
(Inherited from Control.)
Public property Parent
Gets a reference to the server control's parent control in the page control hierarchy.
(Inherited from Control.)
Public property PasteMode
Specifies the manner in which the editor handles pasted text.
Public property PDFPageStyle
Public property PlainText
Retrieves the RichTextEditor HTML content in plain text format.
Public property PlainTextWithLinefeeds
Retrieves the RichTextEditor HTML content in plain text format and replace carriage returns with the appropriate br and p tags for breaks.
Public property PreviewCss
Specifies the location of the style sheet that will be used by the preview window. Multiple Style Sheets are supported. Example PreviewCss="example.css,~/portal.css,/default.css"
Public property PreviewCssText
Gets or sets inline CSS text that will be used by the preview window. Example PreviewCssText="div,p{font:Normal 12px 'Segoe UI'}"
Public property ReadOnly
Gets or sets a value which indicates whether the RichTextEditor should be an active HTML editor, or a read-only document viewer.
Public property RenderMode
Gets or sets the render mode of RichTextEditor.
Public property RenderRichUI
Gets whether the RichTextEditor control will render Rich UI.
Public property RenderSupportAjax
By default RichTextEditor automatically render html code to support AJAX. You can turn it off by setting this property to "false" for non-Ajax pages.
Public property ResizeMode
Gets or sets the resize mode.
Public property SaveButtonMode
Specifies the behavior when the "save" button is clicked in the editor.
Public property SaveButtonScript
Defines the javascript function that will be executed when clicking the "save" button. If it returns false, the submit event will be cancelled. Editor1.SaveButtonScript="return mysubmitfunc()";
Public property SecurityPolicyFile
Specifies the security policy file which contains a configurable set of rules called security policy.
Public property ShiftEnterKeyTag
Specifies the behavior when the "enter" key is pressed while shift is held down in the editor.
Public property ShowBottomBar
Specifies whether to display the editor bottom bar.
Public property ShowCodeMode
Specifies whether to display the Code Mode button in the editor bottom bar.
Public property ShowCodeToolbar
Specifies whether to display the editor code view toolbar.
Public property ShowEditMode
Specifies whether to display the Edit Mode button in the editor bottom bar.
Public property ShowLinkbar
When a hyperlink is selected, a link editing box will be displayed in the editor. You can turn it off by setting this property to "false".
Public property ShowPreviewMode
Specifies whether to display the Preview Mode button in the editor bottom bar.
Public property ShowPreviewToolbar
Specifies whether to display the editor preview mode toolbar.
Public property ShowResizeCorner
Specifies whether to display the resize handle at the corner of the editor.
Public property ShowRulers
Gets or sets a value indicating whether to show horizontal and/or vertical rulers.
Public property ShowStatistics
Specifies whether to display the content statistics in the editor bottom bar.
Public property ShowTagList
Specifies whether to display the tag selector in the editor bottom bar.
Public property ShowToolbar
Specifies whether to display the editor toolbar.
Public property ShowZoomView
Specifies whether to display a zoom factor drop down in the editor bottom bar.
Public property Site
Gets information about the container that hosts the current control when rendered on a design surface.
(Inherited from Control.)
Public property Skin
Sets the skin for how the toolbar is draw. You can create your custom skin or choose from predefined skins.
Public property SkinID
Gets or sets the skin to apply to the control.
(Inherited from WebControl.)
Public property Style
Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control.
(Inherited from WebControl.)
Public property StyleBlackList
The editor HTML Filter allows you to accept HTML input from your users, filter it to make sure it contains only an allowed set of tags, attributes and values and then display it without leaving yourself open to XSS holes. StyleBlackList property allows you set a list of style attributes that will be removed from content sources.
Public property StyleWhiteList
The editor HTML Filter allows you to accept HTML input from your users, filter it to make sure it contains only an allowed set of tags, attributes and values and then display it without leaving yourself open to XSS holes. StyleWhiteList property allows you set a list of style attributes that will not be removed from content sources.
Public property TabIndex
Gets or sets the tab index of the Web server control.
(Inherited from WebControl.)
Public property TabSpaces
Gets or sets the number of spaces to be inserted when the user hits the "tab" key.
Public property TagBlackList
The editor HTML Filter allows you to accept HTML input from your users, filter it to make sure it contains only an allowed set of tags, attributes and values and then display it without leaving yourself open to XSS holes. TagBlackList property allows you set a list of html tags that will be removed from content sources.
Protected property TagKey
Gets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers.
(Inherited from WebControl.)
Protected property TagName
Gets the name of the control tag. This property is used primarily by control developers.
(Inherited from WebControl.)
Public property TagWhiteList
The editor HTML Filter allows you to accept HTML input from your users, filter it to make sure it contains only an allowed set of tags, attributes and values and then display it without leaving yourself open to XSS holes. TagWhiteList property allows you set a list of html tags that will not be removed from content sources.
Public property TemplateControl
Gets or sets a reference to the template that contains this control.
(Inherited from Control.)
Public property TemplateGroupArray
An array of code snippet groups which will be displayed in code snippets treeview as treenode.
Public property TemplateItemArray
An array of predefined code snippets which will be displayed in code snippets treeview as treeitem.
Public property TemplateSourceDirectory
Gets the virtual directory of the Page or UserControl that contains the current server control.
(Inherited from Control.)
Public property TemplateUrlArray
An array of xml files. Those xml files should contain predefined set of code snippets which will be displayed in the code snippets treeview. editor.TemplateUrlArray = new string[] { "mytemplates.xml"};
Public property Text
This property provides access to the text within the editable area of the RichTextEditor control. It can be used to set the text when the control is first displayed and also to read out the text when a form has been submitted.
Public property TextDirection
Gets or sets the text writing direction of the RichTextEditor control: left to right or right to left.
Public property ToggleBorder
Specifies the ToggleBorder state. ToggleBorder is a handy function which allows you to see the borders without setting things to border = 1 or something like that in code. It's used for all HTML Tables, HTML Cells, Forms and Divs.
Public property Toolbar
Auto configures the toolbar with a set of buttons. Provides a mechanism for rapidly autoconfigures the toolbar with a set of predefined buttons. For example to enable every toolbar button and menu, do this: editor1.Toolbar="full". Note that this method will affect properties of the editor, so it is usually best to call it before any other property or method.
Public property ToolbarItems
Gets or sets the list of tool bar items.
Public property ToolTip
Gets or sets the text displayed when the mouse pointer hovers over the Web server control.
(Inherited from WebControl.)
Public property UniqueID
Gets the unique, hierarchically qualified identifier for the editor control.
(Overrides Control..::..UniqueID.)
Public property URLType
Specifies whether the URL should be converted to a site root relative path (/html/images/image1.gif) or an absolute path (http://www.mysite.com/images/image1.gif).
Public property UseHTMLEntities
By default Rich Text Editor maps most special characters to the equivalent HTML entity automatically. You can turn it off by setting this property to "false".
Public property UseSimpleAmpersand
W3C recommend that all '&' in query strings be converted to & This is the only way to get a piece of HTML validated. The reason is that & is the start of an HTML entity, such as £

So this:

        <a href="page.aspx?var1=one&amp;va­r2=two">link</a>
is valid, whereas:
        <a href="page.aspx?var1=one&var2=t­wo">link</a>
isn't.
If you still want to use simple Ampersand in query strings, you can set this property to true. if you want to retrieve the RichTextEditor HTML content in XHTML format, the 'UseSimpleAmpersand' property will be ignored.
Protected property ViewState
Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page.
(Inherited from Control.)
Protected property ViewStateIgnoresCase
Gets a value that indicates whether the StateBag object is case-insensitive.
(Inherited from Control.)
Public property Visible
Gets or sets a value that indicates whether a server control is rendered as UI on the page.
(Inherited from Control.)
Public property Width
Gets or sets the width of the Web server control.
(Inherited from WebControl.)
Public property XHTML
Retrieves the RichTextEditor HTML content in XHTML format.

See Also