The Editor type exposes the following members.
Properties
Name | Description | |
---|---|---|
AccessKey |
Gets or sets the access key that allows you to quickly navigate to the Web server control.
(Inherited from WebControl.) |
|
Adapter |
Gets the browser-specific adapter for the control.
(Inherited from Control.) |
|
AjaxPostbackUrl |
Specify a URL to process editor ajax requests and upload requests.
|
|
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.
|
|
AppRelativeTemplateSourceDirectory |
Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control.
(Inherited from Control.) |
|
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.
|
|
Attributes |
Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control.
(Inherited from WebControl.) |
|
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.
|
|
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.
|
|
AutoParseClasses |
Specifies whether or not the RichTextEditor should automatically parse the CSS classes from ContentCss and populate all items into CssClass dropdown
|
|
BackColor |
Gets or sets the background color of the Web server control.
(Inherited from WebControl.) |
|
BaseHref |
Sets or retrieves the baseline URL on which relative links will be based.
|
|
BBCode |
Gets or sets the bbcode contents of RichTextEditor.
|
|
BindingContainer |
Gets the control that contains this control's data binding.
(Inherited from Control.) |
|
BorderColor |
Gets or sets the border color of the Web control.
(Inherited from WebControl.) |
|
BorderStyle |
Gets or sets the border style of the Web server control.
(Inherited from WebControl.) |
|
BorderWidth |
Gets or sets the border width of the Web server control.
(Inherited from WebControl.) |
|
BrowserType |
Gets the browser type as detected by the HTTP headers sent by the browser.
|
|
ChildControlsCreated |
Gets a value that indicates whether the server control's child controls have been created.
(Inherited from Control.) |
|
ClientFolder |
Sets the path where you want to store the editor client script files.
|
|
ClientID |
Gets the server control identifier generated by ASP.NET.
(Inherited from Control.) |
|
ClientIDSeparator |
Gets a character value representing the separator character used in the ClientID property.
(Inherited from Control.) |
|
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"
|
|
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}"
|
|
Context |
Returns the current HTTP context.
|
|
ContextMenuMode |
Determines the appearance and behavior of menus associated with the Context menu.
|
|
Controls |
Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy.
(Inherited from Control.) |
|
ControlStyle |
Gets the style of the Web server control. This property is used primarily by control developers.
(Inherited from WebControl.) |
|
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.) |
|
CssClass |
Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client.
(Inherited from WebControl.) |
|
DesignDocType |
Defines which version of HTML that RichTextEditor uses in the editor content area.
|
|
DesignMode |
Gets a value indicating whether a control is being used on a design surface.
(Inherited from Control.) |
|
DisableClassList |
The class items in the style dropdown needed to be disabled going to this string.
Example
DisableClassList="BreadCrumb, TopicMenu, Footer"
|
|
DisabledItems |
The toolbar items needed to be disabled going to this string. Example DisabledItems="Bold, New, Delete"
|
|
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.
|
|
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.
|
|
EditCompleteDocument |
Specifies whether a complete HTML document is being edited.
|
|
EditorBodyClass |
Specifies the Class name that will be added to the body of the editor document.
|
|
EditorBodyId |
Specifies an Id name that will be added to the body of the editor document.
|
|
EditorBodyStyle |
Specifies the css style that will be applied to the body of the editor document.
|
|
EditorMode |
Determines which mode (Edit/Code/View) the editor is in.
|
|
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".
|
|
EnableContextMenu |
Gets or sets a value indicating whether to display the context menu, which appears when the right mouse button is clicked.
|
|
Enabled |
Gets or sets a value indicating whether the Web server control is enabled.
(Inherited from WebControl.) |
|
EnableDragDrop |
Enables or disables drag-and-drop support for the editor.
|
|
EnableIEBorderRadius |
Gets or sets a value indicating whether to render the rounded corners using border-radius in IE.
|
|
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".
|
|
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.
|
|
EnableTheming |
Gets or sets a value indicating whether themes apply to this control.
(Inherited from WebControl.) |
|
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.) |
|
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.
|
|
EnterKeyTag |
Specifies the behavior when the "enter" key is pressed in the editor.
|
|
Events |
Gets a list of event handler delegates for the control. This property is read-only.
(Inherited from Control.) |
|
Font |
Gets the font properties associated with the Web server control.
(Inherited from WebControl.) |
|
ForeColor |
Gets or sets the foreground color (typically the color of the text) of the Web server control.
(Inherited from WebControl.) |
|
FullScreen |
Gets or sets whether the RichTextEditor control is used in a full-screen mode.
|
|
HasAttributes |
Gets a value indicating whether the control has attributes set.
(Inherited from WebControl.) |
|
HasChildViewState |
Gets a value indicating whether the current server control's child controls have any saved view-state settings.
(Inherited from Control.) |
|
Height |
Gets or sets the height of the Web server control.
(Inherited from WebControl.) |
|
ID |
Gets or sets the programmatic identifier assigned to the server control.
(Inherited from Control.) |
|
IdSeparator |
Gets the character used to separate control identifiers.
(Inherited from Control.) |
|
IsChildControlStateCleared |
Gets a value indicating whether controls contained within this control have control state.
(Inherited from Control.) |
|
IsEnabled |
Gets a value indicating whether the control is enabled.
(Inherited from WebControl.) |
|
IsMvcMode |
This property returns true if the editor is running in Mvc mode
|
|
IsTrackingViewState |
Gets a value that indicates whether the server control is saving changes to its view state.
(Inherited from Control.) |
|
IsViewStateEnabled |
Gets a value indicating whether view state is enabled for this control.
(Inherited from Control.) |
|
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] ,
|
|
LinkGroupArray |
An array of link groups which will be displayed in internal links treeview as treenode.
|
|
LinkItemArray |
An array of predefined hyperlinks which will be displayed in internal links treeview as treeitem.
|
|
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"};
|
|
LoadDelay |
Gets or sets the delay, in milliseconds, before the editor loading operation is started.
|
|
LoadViewStateByID |
Gets a value indicating whether the control participates in loading its view state by ID instead of index.
(Inherited from Control.) |
|
MaxHTMLLength |
Gets or sets the maximum number of characters including the HTML tags allowed in the RichTextEditor.
Default is -1, indicating no maximum.
|
|
MaxTextLength |
Gets or sets the maximum number of characters excluding the HTML tags allowed in the RichTextEditor.
Default is -1, indicating no maximum.
|
|
MvcContext |
Returns the current HTTP context.
|
|
Name |
Gets or sets the name of the editor control.
|
|
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.) |
|
Page |
Gets a reference to the Page instance that contains the server control.
(Inherited from Control.) |
|
Parent |
Gets a reference to the server control's parent control in the page control hierarchy.
(Inherited from Control.) |
|
PasteMode |
Specifies the manner in which the editor handles pasted text.
|
|
PDFPageStyle | ||
PlainText |
Retrieves the RichTextEditor HTML content in plain text format.
|
|
PlainTextWithLinefeeds |
Retrieves the RichTextEditor HTML content in plain text format and replace carriage returns with the appropriate br and p tags for breaks.
|
|
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"
|
|
PreviewCssText |
Gets or sets inline CSS text that will be used by the preview window. Example PreviewCssText="div,p{font:Normal 12px 'Segoe UI'}"
|
|
ReadOnly |
Gets or sets a value which indicates whether the RichTextEditor should be an active HTML editor, or a read-only document viewer.
|
|
RenderMode |
Gets or sets the render mode of RichTextEditor.
|
|
RenderRichUI |
Gets whether the RichTextEditor control will render Rich UI.
|
|
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.
|
|
ResizeMode |
Gets or sets the resize mode.
|
|
SaveButtonMode |
Specifies the behavior when the "save" button is clicked in the editor.
|
|
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()";
|
|
SecurityPolicyFile |
Specifies the security policy file which contains a configurable set of rules called security policy.
|
|
ShiftEnterKeyTag |
Specifies the behavior when the "enter" key is pressed while shift is held down in the editor.
|
|
ShowBottomBar |
Specifies whether to display the editor bottom bar.
|
|
ShowCodeMode |
Specifies whether to display the Code Mode button in the editor bottom bar.
|
|
ShowCodeToolbar |
Specifies whether to display the editor code view toolbar.
|
|
ShowEditMode |
Specifies whether to display the Edit Mode button in the editor bottom bar.
|
|
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".
|
|
ShowPreviewMode |
Specifies whether to display the Preview Mode button in the editor bottom bar.
|
|
ShowPreviewToolbar |
Specifies whether to display the editor preview mode toolbar.
|
|
ShowResizeCorner |
Specifies whether to display the resize handle at the corner of the editor.
|
|
ShowRulers |
Gets or sets a value indicating whether to show horizontal and/or vertical rulers.
|
|
ShowStatistics |
Specifies whether to display the content statistics in the editor bottom bar.
|
|
ShowTagList |
Specifies whether to display the tag selector in the editor bottom bar.
|
|
ShowToolbar |
Specifies whether to display the editor toolbar.
|
|
ShowZoomView |
Specifies whether to display a zoom factor drop down in the editor bottom bar.
|
|
Site |
Gets information about the container that hosts the current control when rendered on a design surface.
(Inherited from Control.) |
|
Skin |
Sets the skin for how the toolbar is draw.
You can create your custom skin or choose from predefined skins.
|
|
SkinID |
Gets or sets the skin to apply to the control.
(Inherited from WebControl.) |
|
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.) |
|
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.
|
|
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.
|
|
TabIndex |
Gets or sets the tab index of the Web server control.
(Inherited from WebControl.) |
|
TabSpaces |
Gets or sets the number of spaces to be inserted when the user hits the "tab" key.
|
|
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.
|
|
TagKey |
Gets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers.
(Inherited from WebControl.) |
|
TagName |
Gets the name of the control tag. This property is used primarily by control developers.
(Inherited from WebControl.) |
|
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.
|
|
TemplateControl |
Gets or sets a reference to the template that contains this control.
(Inherited from Control.) |
|
TemplateGroupArray |
An array of code snippet groups which will be displayed in code snippets treeview as treenode.
|
|
TemplateItemArray |
An array of predefined code snippets which will be displayed in code snippets treeview as treeitem.
|
|
TemplateSourceDirectory |
Gets the virtual directory of the Page or UserControl that contains the current server control.
(Inherited from Control.) |
|
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"};
|
|
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.
|
|
TextDirection |
Gets or sets the text writing direction of the RichTextEditor control: left to right or right to left.
|
|
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.
|
|
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.
|
|
ToolbarItems |
Gets or sets the list of tool bar items.
|
|
ToolTip |
Gets or sets the text displayed when the mouse pointer hovers over the Web server control.
(Inherited from WebControl.) |
|
UniqueID |
Gets the unique, hierarchically qualified identifier for the editor control.
(Overrides Control..::..UniqueID.) |
|
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).
|
|
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".
|
|
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: 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. |
|
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.) |
|
ViewStateIgnoresCase |
Gets a value that indicates whether the StateBag object is case-insensitive.
(Inherited from Control.) |
|
Visible |
Gets or sets a value that indicates whether a server control is rendered as UI on the page.
(Inherited from Control.) |
|
Width |
Gets or sets the width of the Web server control.
(Inherited from WebControl.) |
|
XHTML |
Retrieves the RichTextEditor HTML content in XHTML format.
|