Skip to main content
A newer version of this page is available. .

ASPxHtmlEditor Properties

An HTML text editor control.
Name Description
AccessibilityCompliant Enables accessibility support.
AccessKey Gets or sets the access key that allows you to quickly navigate to the Web server control. Inherited from WebControl.
ActiveView Gets or sets the editor’s active view.
Adapter protected Gets the browser-specific adapter for the control. Inherited from Control.
AppRelativeTemplateSourceDirectory Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. Inherited from Control.
AssociatedRibbonID Specifies the ID of an ASPxRibbon control, used as an external toolbar.
Attributes Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. Inherited from WebControl.
BackColor Gets or sets the background color of the Web server control. Inherited from WebControl.
BackgroundImage This property is not in effect for the ASPxHtmlEditor class.
BackwardCompatibility static Provides access to the control’s backward compatibility settings. Inherited from ASPxWebControl.
Border Gets the web control’s border settings. Inherited from ASPxWebControl.
BorderBottom Gets the settings of the web control’s bottom border. Inherited from ASPxWebControl.
BorderLeft Gets the settings of the web control’s left border. Inherited from ASPxWebControl.
BorderRight Gets the settings of the web control’s right border. Inherited from ASPxWebControl.
BorderTop Gets the settings of the web control’s top border. Inherited from ASPxWebControl.
ChildControlsCreated protected Gets a value that indicates whether the server control’s child controls have been created. Inherited from Control.
ClientEnabled Gets or sets a value that indicates whether an ASPxHtmlEditor is enabled on the client.
ClientID Gets the control’s identifier generated by ASP.NET. Inherited from ASPxWebControlBase.
ClientIDMode Gets or sets the algorithm that is used to generate the value of the ClientID property. Inherited from Control.
ClientIDSeparator protected Gets a character value representing the separator character used in the ClientID property. Inherited from Control.
ClientInstanceName Gets or sets the ASPxHtmlEditor‘s client programmatic identifier.
ClientSideEvents Gets an object that lists the client-side events specific to the ASPxHtmlEditor.
ClientVisible Gets or sets a value that specifies the initial visibility state of a web control on the client.
Context protected Gets the HttpContext object associated with the server control for the current Web request. Inherited from Control.
ContextMenuItems Gets the collection of items displayed within the editor’s context menu.
Controls Gets the web control’s collection of child controls. Inherited from ASPxWebControlBase.
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.
CssFilePath This property is not in effect for the ASPxHtmlEditor class. Use the StylesBase.CssFilePath property instead.
CssFiles Gets a collection of items that refer to external CSS files associated with the ASPxHtmlEditor object.
CssPostfix This property is not in effect for the ASPxHtmlEditor class. Use the StylesBase.CssPostfix property instead.
Cursor Gets or sets the type of cursor to display when the mouse pointer is over the web control. Inherited from ASPxWebControl.
CustomDialogs Provides access to custom dialogs added to the editor.
DataItemContainer Gets a reference to the naming container if the naming container implements IDataItemContainer. Inherited from Control.
DataKeysContainer Gets a reference to the naming container if the naming container implements IDataKeysControl. Inherited from Control.
DisabledCssClass static Gets or sets the CSS class to apply to the rendered HTML element when the control is disabled. Inherited from WebControl.
DisabledStyle This property is not in effect for the ASPxHtmlEditor class.
EmptyImage static Obsolete. Gets the settings of an image which is displayed by the control if the control’s value is null. Inherited from ASPxWebControl.
EnableCallbackAnimation Gets or sets a value that specifies whether a specific animation effect is used when a control’s content is updated via a callback.
EnableCallbackCompression Gets or sets whether callback result compression is enabled.
Enabled Gets or sets a value that indicates whether a web control is enabled, allowing it to respond to end-user interactions. Inherited from ASPxWebControl.
EnableDefaultAppearance Obsolete. Specifies whether to enable the control’s default appearance. Inherited from ASPxWebControl.
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.
EncodeHtml Gets or sets a value that specifies whether the web control’s value and element content are rendered as pure HTML, or HTML markers are stripped out. Inherited from ASPxWebControl.
ErrorText Gets or sets the error text to be displayed within the editor’s error frame, if the editor’s validation fails.
Events protected 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.
GlobalAccessibilityCompliant static Gets or sets whether accessibility support is globally enabled for all DevExpress web controls across the web page or the entire web site. Inherited from ASPxWebControl.
GlobalCheckReferencesToExternalScripts static Gets or sets whether the availability and correctness of references to external client scripts (such as jQuery, jQuery UI, Knockout, etc.), which are used by certain DevExpress web controls, are checked. Inherited from ASPxWebControl.
GlobalEmbedRequiredClientLibraries static Obsolete. Gets or sets whether external client libraries (including scripts and CSS files) are automatically embedded in the DevExpress.Web assembly as resources. Inherited from ASPxWebControl.
GlobalRightToLeft static Gets or sets that the right-to-left orientation shall be globally applied to all DevExpress web controls across the web page or the entire web site. Inherited from ASPxWebControl.
GlobalStyleSheetTheme static Gets or sets the name of the style sheet theme to be globally applied to all DevExpress web controls across the entire web site. Inherited from ASPxWebControl.
GlobalTheme static Gets or sets the name of the Theme to be globally applied to all DevExpress web controls across the entire web site. Inherited from ASPxWebControl.
GlobalThemeBaseColor static Gets or sets the base color for the theme to be globally applied to all DevExpress web controls across a web page or entire web site. Inherited from ASPxWebControl.
GlobalThemeFont static Gets or sets the font settings of the theme to be globally applied to all DevExpress web controls across a web page or entire web site. Inherited from ASPxWebControl.
HasAttributes Gets a value indicating whether the control has attributes set. Inherited from WebControl.
HasChildViewState protected 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 ASPxWebControl.
Html Specifies the HTML markup that is the ASPxHtmlEditor‘s content.
ID Gets or sets the programmatic identifier assigned to the server control. Inherited from Control.
IdSeparator protected Gets the character used to separate control identifiers. Inherited from Control.
Images Provides access to the settings that define images displayed within specific visual elements of the ASPxHtmlEditor.
ImagesEditors Provides access to the settings that define images displayed within different editors used within the ASPxHtmlEditor control and its dialog forms.
ImagesFileManager Provides access to the settings that define images displayed within the Image Selector and Document Selector.
Initialized Gets a value indicating whether the web control has been initialized. Inherited from ASPxWebControlBase.
IsCallback Gets a value indicating whether the request is the result of a callback sent by the control. Inherited from ASPxWebControl.
IsChildControlStateCleared protected Gets a value indicating whether controls contained within this control have control state. Inherited from Control.
IsTrackingViewState protected Gets a value that indicates whether the server control is saving changes to its view state. Inherited from Control.
IsValid Gets or sets a value that indicates whether the editor’s value passes validation.
IsViewStateEnabled protected Gets a value indicating whether view state is enabled for this control. Inherited from Control.
JSProperties Enables you to supply any server data that can then be parsed on the client.
Loaded Indicates whether a web control has been loaded into the Page object. Inherited from ASPxWebControlBase.
LoadViewStateByID protected Gets a value indicating whether the control participates in loading its view state by ID instead of index. Inherited from 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.
ParentImages This property is not in effect for the ASPxWebControl class. Inherited from ASPxWebControl.
ParentStyles This property is not in effect for the ASPxWebControl class. Inherited from ASPxWebControl.
PartsRoundPanel Obsolete. Provides access to the settings that define different part of round panel used within the ASPxHtmlEditor control.
Placeholders Gets the collection of placeholders available in the ASPxHtmlEditor.
RenderIFrameForPopupElements Gets or sets a value that specifies whether the editor’s popup dialogs are displayed above Java applets that may present on the web page.
RenderingCompatibility Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with. Inherited from Control.
RibbonContextTabCategories Gets the collection of ribbon context tab categories.
RibbonTabs Provides access to the collection of Ribbon tabs.
RightToLeft Gets or sets a value specifying whether or not the current control supports right-to-left representation.
SaveStateToCookies Gets or sets a value that specifies whether cookies are used to persist the information about the control.
SaveStateToCookiesID Gets or sets the name (identifier) of the cookie in which the ASPxHtmlEditor’s state is persisted.
Settings Provides access to the ASPxHtmlEditor‘s main settings.
SettingsAdaptivity Provides access to the HTML Editor layout adaptivity settings.
SettingsAudioSelector Obsolete. Provides access to settings related to the Select Audio dialog.
SettingsAudioUpload Obsolete. Provides access to settings related to uploading audio files.
SettingsDialogFormElements Obsolete. Provides access to settings that relate to customization of dialog form elements.
SettingsDialogs Provides access to the built-in dialogs‘ settings.
SettingsDocumentSelector Obsolete. Provides access to settings that are related to the Document Selector dialog.
SettingsFlashSelector Obsolete. Provides access to settings related to the Select Flash dialog.
SettingsFlashUpload Obsolete. Provides access to settings related to uploading flash files.
SettingsHtmlEditing Provides access to settings that relate to editing the HTML markup.
SettingsImageSelector Obsolete. Provides access to settings that are related to the Select Image dialog.
SettingsImageUpload Obsolete. Provides access to settings that relate to uploading images.
SettingsLoadingPanel Provides access to the loading panel‘s settings.
SettingsPlaceholders Provides access to the placeholders settings for the ASPxHtmlEditor.
SettingsResize Provides access to settings that relate to sizing capabilities.
SettingsSpellChecker Provides access to the spelling settings for checking the ASPxHtmlEditor’s content.
SettingsText Provides access to the settings that define texts displayed in different elements (tabs) of the control.
SettingsValidation Provides access to content validation settings.
SettingsVideoSelector Obsolete. Provides access to settings related to the Select Video dialog.
SettingsVideoUpload Obsolete. Provides access to settings related to uploading video files.
ShadowImage static Obsolete. Gets the shadow image properties. Inherited from ASPxWebControl.
Shortcuts Gets the collection of shortcuts available within ASPxHtmlEditor.
Site Gets information about the container that hosts the current control when rendered on a design surface. Inherited from Control.
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.
Styles Provides access to the style settings that define the appearance of the ASPxHtmlEditor‘s different elements.
StylesButton Provides access to the style settings that define the appearance of button elements used by the ASPxHtmlEditor control (within dialog forms, for instance).
StylesContextMenu Provides access to the style settings that define the appearance of the editor’s context menu.
StylesDialogForm Provides access to the style settings that define the appearance of the editor’s dialog forms.
StylesDocument Provides access to the style settings that define the appearance of the document displayed by the editor’s design view area and preview area, and applied to the exported document.
StylesEditors Provides access to the style settings that define the appearance of editor elements used by the ASPxHtmlEditor control (for instance, within dialog forms).
StylesFileManager Provides access to the style settings that control the appearance of the Image Selector‘s elements.
StylesPasteOptionsBar Provides access to the style settings that define the appearance of the editor’s paste options bar.
StylesRoundPanel Provides access to the style settings that define the appearance of round panel controls used by the ASPxHtmlEditor control (for instance, within dialog forms).
StylesSpellChecker Provides access to style settings of the ASPxHtmlEditor‘s built-in spell checker.
StylesStatusBar Provides access to the style settings that define the appearance of the editor’s status bar.
StylesTagInspector Provides access to the style settings that define the appearance of the tag inspector.
StylesToolbars Provides access to the style settings that define the appearance of toolbars.
SupportsDisabledAttribute Gets a value that indicates whether the control should set the disabled attribute of the rendered HTML element to “disabled” when the control’s IsEnabled property is false. Inherited from WebControl.
IControlBuilderAccessor.ControlBuilder For a description of this member, see ControlBuilder. Inherited from Control.
IControlDesignerAccessor.UserData For a description of this member, see UserData. Inherited from Control.
IDataBindingsAccessor.DataBindings For a description of this member, see DataBindings. Inherited from Control.
IDataBindingsAccessor.HasDataBindings For a description of this member, see HasDataBindings. Inherited from Control.
IExpressionsAccessor.Expressions For a description of this member, see Expressions. Inherited from Control.
IExpressionsAccessor.HasExpressions For a description of this member, see HasExpressions. Inherited from Control.
TabIndex Gets or sets the tab index of the Web server control. Inherited from WebControl.
TagKey protected Gets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers. Inherited from WebControl.
TagName protected Gets the name of the control tag. This property is used primarily by control developers. Inherited from WebControl.
TemplateControl Gets or sets a reference to the template that contains this control. Inherited from Control.
TemplateSourceDirectory Gets the virtual directory of the Page or UserControl that contains the current server control. Inherited from Control.
Theme Gets or sets the name of the Theme to be applied to the control. Inherited from ASPxWebControl.
ToolbarMode Specifies the type of the ASPxHtmlEditor toolbar.
Toolbars Gets the collection of toolbars in the ASPxHtmlEditor control.
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 server control. Inherited from Control.
ValidateRequestMode Gets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values. Inherited from Control.
ViewState protected 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 protected Gets a value that indicates whether the StateBag object is case-insensitive. Inherited from Control.
ViewStateMode Gets or sets the view-state mode of this control. Inherited from Control.
Visible Gets or sets a value specifying the current ASPxHtmlEditor control’s visibility.
Width Gets or sets the editor’s width.
See Also