A newer version of this page is available. Switch to the current version.

ASPxHtmlEditor Members

An HTML text editor control.

Constructors

Name Description
ASPxHtmlEditor() Initializes a new instance of the ASPxHtmlEditor class with default settings.

Properties

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.
BindingContainer For internal use only. 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.
BorderColor Gets or sets the border color of the web control. Use the BorderWrapper.BorderColor property instead. 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.
BorderStyle Gets or sets the border style of the web control. Use the BorderWrapper.BorderStyle property instead. Inherited from ASPxWebControl.
BorderTop Gets the settings of the web control's top border. Inherited from ASPxWebControl.
BorderWidth Gets or sets the border width of the web control. Use the BorderWrapper.BorderWidth property instead. 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.
DesignMode For internal use only. Inherited from ASPxWebControl.
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.
IsRendering For internal use only. Inherited from ASPxWebControlBase.
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.
ParentSkinOwner For internal use only. 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.
PostDataLoading For internal use only. Inherited from ASPxWebControl.
PreRendered For internal use only. Inherited from ASPxWebControlBase.
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.
Request For internal use only. Inherited from ASPxWebControl.
Response For internal use only. Inherited from ASPxWebControl.
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.
SettingsForms Gets the settings allowing you to specify paths to dialog forms (UserControls) stored within a web site.
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.
ViewStateLoading For internal use only. Inherited from ASPxWebControl.
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.

Methods

Name Description
AddAttributesToRender(HtmlTextWriter) protected Adds HTML attributes and styles that need to be rendered to the specified HtmlTextWriterTag. This method is used primarily by control developers. Inherited from WebControl.
AddedControl(Control, Int32) protected Called after a child control is added to the Controls collection of the Control object. Inherited from Control.
AddParsedSubObject(Object) protected Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object. Inherited from Control.
ApplyStyle(Style) Copies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers. Inherited from WebControl.
ApplyStyleSheetSkin(Page) Applies the style properties defined in the page style sheet to the control. Inherited from Control.
ApplyStyleSheetThemeInternal() For internal use only. Inherited from ASPxWebControl.
ApplyThemeInternal() For internal use only. Inherited from ASPxWebControl.
BeginRenderTracing(TextWriter, Object) protected Begins design-time tracing of rendering data. Inherited from Control.
BuildProfileTree(String, Boolean) protected Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page. Inherited from Control.
ClearCachedClientID() protected Sets the cached ClientID value to null. Inherited from Control.
ClearChildControlState() protected Deletes the control-state information for the server control's child controls. Inherited from Control.
ClearChildState() protected Deletes the view-state and control-state information for all the server control's child controls. Inherited from Control.
ClearChildViewState() protected Deletes the view-state information for all the server control's child controls. Inherited from Control.
ClearEffectiveClientIDMode() protected Sets the ClientIDMode property of the current control instance and of any child controls to Inherit. Inherited from Control.
CopyBaseAttributes(WebControl) Copies the properties not encapsulated by the Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers. Inherited from WebControl.
CorrectHtml(String) static Validates and corrects the passed HTML code based upon the settings specified by the ASPxHtmlEditor.SettingsHtmlEditing property.
CorrectHtml(String, HtmlEditorHtmlEditingSettings) static Validates and corrects the passed HTML code based upon the settings specified.
CorrectHtml(String, Boolean, Boolean, Boolean, Boolean, Boolean) static Validates and corrects the passed HTML code based upon the options specified.
CorrectHtml(String, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, AllowedDocumentType) static Validates and corrects the passed HTML code based upon the options specified.
CorrectHtml(String, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, AllowedDocumentType, Boolean, Boolean, Boolean) static Validates and corrects the passed HTML code based upon the options specified.
CorrectHtml(String, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, AllowedDocumentType, Boolean, Boolean, Boolean, Boolean, HtmlEditorContentElementFiltering) static Validates and corrects the passed HTML code based upon the options specified.
CreateControlCollection() protected Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control. Inherited from Control.
CreateDefaultRibbonContextTabCategories(Boolean) Creates default context tab categories in the ASPxHtmlEditor's ribbon.
CreateDefaultRibbonTabs(Boolean) Creates a collection of default Ribbon tabs, specifying what to do with tabs that already exist within the ASPxHtmlEditor.RibbonTabs collection.
CreateDefaultToolbars(Boolean) Creates a collection of default toolbars, specifying what to do with toolbars that already exist within the ASPxHtmlEditor.Toolbars collection.
DataBind() Binds the ASPxHtmlEditor's custom toolbar items (such as a dropdown item picker or dropdown menu toolbar items) to their data sources, if any are defined.
DataBind(Boolean) protected Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event. Inherited from Control.
DataBindChildren() protected Binds a data source to the server control's child controls. Inherited from Control.
Dispose() Enables a server control to perform final clean up before it is released from memory. Inherited from Control.
EndRenderTracing(TextWriter, Object) protected Ends design-time tracing of rendering data. Inherited from Control.
EnsureID() protected Creates an identifier for controls that do not have an identifier assigned. Inherited from Control.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Export(HtmlEditorExportFormat) Exports editor contents to the specified format.
Export(HtmlEditorExportFormat, Boolean) Exports editor contents to the specified format, based on the provided settings.
Export(HtmlEditorExportFormat, Stream) Exports editor contents to the specified format, based on the provided settings.
Export(HtmlEditorExportFormat, String) Exports editor contents to the specified format, based on the provided settings.
FindControl(String) Searches the current naming container for a server control with the specified id parameter. Inherited from Control.
FindControl(String, Int32) protected Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the FindControl method. Inherited from Control.
Focus() Sets input focus to the web control. Inherited from ASPxWebControl.
GetCallbackErrorMessage() static Obtains the error info while processing the redirection page. Inherited from ASPxWebControl.
GetClientSideEventHandler(String) Returns the specified client event's handler. Inherited from ASPxWebControl.
GetControlStyle() For internal use only. Inherited from ASPxWebControl.
GetCssClassNamePrefix() For internal use only. Inherited from ASPxWebControl.
GetCssClassNamePrefix(String) For internal use only. Inherited from ASPxWebControl.
GetDefaultBooleanProperty(String, DefaultBoolean) For internal use only. Inherited from ASPxWebControl.
GetDesignModeState() protected Gets design-time data for a control. Inherited from Control.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetInsertImageDialogConstrainProportionsBottom() Returns the ImageProperties object representing the bottom part of a specific constrain proportions image displayed within the ASPxHtmlEditor's Insert image dialog.
GetInsertImageDialogConstrainProportionsMiddleOff() Returns the ImageProperties object representing the switched off middle part of a specific constrain proportions image within the ASPxHtmlEditor's Insert image dialog.
GetInsertImageDialogConstrainProportionsMiddleOn() Returns the ImageProperties object representing the switched on middle part of a specific constrain proportions image within the ASPxHtmlEditor's Insert image dialog.
GetInsertImageDialogConstrainProportionsTop() Returns the ImageProperties object representing the top part of a specific constrain proportions image within the ASPxHtmlEditor's Insert image dialog.
GetPaddings() For internal use only. Inherited from ASPxWebControl.
GetResourceUrl(Page, String) static Returns a URL reference to an embedded resource in an assembly. Inherited from ASPxWebControl.
GetResourceUrl(Page, Type, String) static Returns a URL reference to an embedded resource in an assembly. Inherited from ASPxWebControl.
GetRouteUrl(Object) Gets the URL that corresponds to a set of route parameters. Inherited from Control.
GetRouteUrl(String, Object) Gets the URL that corresponds to a set of route parameters and a route name. Inherited from Control.
GetRouteUrl(String, RouteValueDictionary) Gets the URL that corresponds to a set of route parameters and a route name. Inherited from Control.
GetRouteUrl(RouteValueDictionary) Gets the URL that corresponds to a set of route parameters. Inherited from Control.
GetStatusBarSizeGripImageProperties() For internal use only.
GetType() Gets the Type of the current instance. Inherited from Object.
GetUniqueIDRelativeTo(Control) Returns the prefixed portion of the UniqueID property of the specified control. Inherited from Control.
HasControls() Determines if the server control contains any child controls. Inherited from Control.
HasEvents() protected Returns a value indicating whether events are registered for the control or any child controls. Inherited from Control.
HtmlEncode(String) For internal use only. Inherited from ASPxWebControl.
HtmlEncode(String, Boolean) For internal use only. Inherited from ASPxWebControl.
Import(HtmlEditorImportFormat, Stream) Imports the editor content from a specific stream, based on the provided settings.
Import(HtmlEditorImportFormat, Stream, Boolean) Imports the editor content from a specific stream, based on the provided settings.
Import(HtmlEditorImportFormat, Stream, Boolean, String) Imports the editor content from a specific stream, based on the provided settings.
Import(HtmlEditorImportFormat, Stream, String) Imports the editor content from a specific stream, based on the provided settings.
Import(HtmlEditorImportFormat, String) Imports the editor content from the specified file.
Import(HtmlEditorImportFormat, String, Boolean) Imports the editor content from a specific file, based on the provided settings.
Import(HtmlEditorImportFormat, String, Boolean, String) Imports the editor content from a specific file, based on the provided settings.
Import(HtmlEditorImportFormat, String, String) Imports the editor content from a specific file, based on the provided settings.
Import(String) Imports the editor content from a specific file.
Import(String, Boolean) Imports the editor content from a specific file, based on the provided settings.
Import(String, Boolean, String) Imports the editor content from a specific file, based on the provided settings.
Import(String, String) Imports the editor content from a specific file, based on the provided settings.
IsAccessibilityCompliantRender() Returns a value that indicates whether the control's accessible html code is rendered. Inherited from ASPxWebControl.
IsAccessibilityCompliantRender(Boolean) Returns a value that indicates whether the control's accessible html code is rendered. Inherited from ASPxWebControl.
IsClientSideAPIEnabled() Returns a value that indicates whether a specific programmatic interface (in particular, specific JavaScript objects and methods) are available to the control on the client side. Inherited from ASPxWebControl.
IsClientSideEventsAssigned() For internal use only. Inherited from ASPxWebControl.
IsClientVisible() For internal use only. Inherited from ASPxWebControl.
IsEnabled() Returns a value that specifies whether a web control is enabled. Inherited from ASPxWebControlBase.
IsLiteralContent() protected Determines if the server control holds only literal content. Inherited from Control.
IsLoading() This member supports the internal infrastructure and is not intended to be used directly from your code. Inherited from ASPxWebControl.
IsNativeRender() For internal use only. Inherited from ASPxWebControl.
IsViewStateStoring() For internal use only. Inherited from ASPxWebControlBase.
IsVisible() Returns a value that specifies whether the current web control is displayed. Inherited from ASPxWebControlBase.
LoadControlState(Object) protected Restores control-state information from a previous page request that was saved by the SaveControlState() method. Inherited from Control.
MakeResponseCompressed() static Specifies that the response code (the HTML code of the web page) should be compressed on the server before sending it to the client. Inherited from ASPxWebControl.
MakeResponseCompressed(Boolean) static Specifies that the response code (the HTML code of the web page) should be compressed on the server before sending it to the client, and accepts a parameter specifying whether to apply compression to IE6. Inherited from ASPxWebControl.
MapPathSecure(String) protected Retrieves the physical path that a virtual path, either absolute or relative, maps to. Inherited from Control.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
MergeStyle(Style) Copies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers. Inherited from WebControl.
OnBubbleEvent(Object, EventArgs) protected Determines whether the event for the server control is passed up the page's UI server control hierarchy. Inherited from Control.
OnDataBinding(EventArgs) protected Raises the DataBinding event. Inherited from Control.
OnUnload(EventArgs) protected Raises the Unload event. Inherited from Control.
OpenFile(String) protected Gets a Stream used to read a file. Inherited from Control.
RaiseAudioFileSaving(FileSavingEventArgs) This member supports the internal infrastructure and is not intended to be used directly from your code.
RaiseAudioSelectorCustomThumbnail(FileManagerThumbnailCreateEventArgs) This member supports the internal infrastructure and is not intended to be used directly from your code.
RaiseAudioSelectorFileUploading(FileManagerFileUploadEventArgs) This member supports the internal infrastructure and is not intended to be used directly from your code.
RaiseAudioSelectorFolderCreating(FileManagerFolderCreateEventArgs) This member supports the internal infrastructure and is not intended to be used directly from your code.
RaiseAudioSelectorItemCopying(FileManagerItemCopyEventArgs) This member supports the internal infrastructure and is not intended to be used directly from your code.
RaiseAudioSelectorItemDeleting(FileManagerItemDeleteEventArgs) This member supports the internal infrastructure and is not intended to be used directly from your code.
RaiseAudioSelectorItemMoving(FileManagerItemMoveEventArgs) This member supports the internal infrastructure and is not intended to be used directly from your code.
RaiseAudioSelectorItemRenaming(FileManagerItemRenameEventArgs) This member supports the internal infrastructure and is not intended to be used directly from your code.
RaiseBubbleEvent(Object, EventArgs) protected Assigns any sources of the event and its information to the control's parent. Inherited from Control.
RaiseDocumentSelectorCustomThumbnail(FileManagerThumbnailCreateEventArgs) This member supports the internal infrastructure and is not intended to be used directly from your code.
RaiseDocumentSelectorFileUploading(FileManagerFileUploadEventArgs) This member supports the internal infrastructure and is not intended to be used directly from your code.
RaiseDocumentSelectorFolderCreating(FileManagerFolderCreateEventArgs) This member supports the internal infrastructure and is not intended to be used directly from your code.
RaiseDocumentSelectorItemCopying(FileManagerItemCopyEventArgs) This member supports the internal infrastructure and is not intended to be used directly from your code.
RaiseDocumentSelectorItemDeleting(FileManagerItemDeleteEventArgs) This member supports the internal infrastructure and is not intended to be used directly from your code.
RaiseDocumentSelectorItemMoving(FileManagerItemMoveEventArgs) This member supports the internal infrastructure and is not intended to be used directly from your code.
RaiseDocumentSelectorItemRenaming(FileManagerItemRenameEventArgs) This member supports the internal infrastructure and is not intended to be used directly from your code.
RaiseFlashFileSaving(FileSavingEventArgs) This member supports the internal infrastructure and is not intended to be used directly from your code.
RaiseFlashSelectorCustomThumbnail(FileManagerThumbnailCreateEventArgs) This member supports the internal infrastructure and is not intended to be used directly from your code.
RaiseFlashSelectorFileUploading(FileManagerFileUploadEventArgs) This member supports the internal infrastructure and is not intended to be used directly from your code.
RaiseFlashSelectorFolderCreating(FileManagerFolderCreateEventArgs) This member supports the internal infrastructure and is not intended to be used directly from your code.
RaiseFlashSelectorItemCopying(FileManagerItemCopyEventArgs) This member supports the internal infrastructure and is not intended to be used directly from your code.
RaiseFlashSelectorItemDeleting(FileManagerItemDeleteEventArgs) This member supports the internal infrastructure and is not intended to be used directly from your code.
RaiseFlashSelectorItemMoving(FileManagerItemMoveEventArgs) This member supports the internal infrastructure and is not intended to be used directly from your code.
RaiseFlashSelectorItemRenaming(FileManagerItemRenameEventArgs) This member supports the internal infrastructure and is not intended to be used directly from your code.
RaiseImageFileSaving(FileSavingEventArgs) This member supports the internal infrastructure and is not intended to be used directly from your code.
RaiseImageSelectorCustomThumbnail(FileManagerThumbnailCreateEventArgs) This member supports the internal infrastructure and is not intended to be used directly from your code.
RaiseImageSelectorFileUploading(FileManagerFileUploadEventArgs) This member supports the internal infrastructure and is not intended to be used directly from your code.
RaiseImageSelectorFolderCreating(FileManagerFolderCreateEventArgs) This member supports the internal infrastructure and is not intended to be used directly from your code.
RaiseImageSelectorItemCopying(FileManagerItemCopyEventArgs) This member supports the internal infrastructure and is not intended to be used directly from your code.
RaiseImageSelectorItemDeleting(FileManagerItemDeleteEventArgs) This member supports the internal infrastructure and is not intended to be used directly from your code.
RaiseImageSelectorItemMoving(FileManagerItemMoveEventArgs) This member supports the internal infrastructure and is not intended to be used directly from your code.
RaiseImageSelectorItemRenaming(FileManagerItemRenameEventArgs) This member supports the internal infrastructure and is not intended to be used directly from your code.
RaiseVideoFileSaving(FileSavingEventArgs) This member supports the internal infrastructure and is not intended to be used directly from your code.
RaiseVideoSelectorCustomThumbnail(FileManagerThumbnailCreateEventArgs) This member supports the internal infrastructure and is not intended to be used directly from your code.
RaiseVideoSelectorFileUploading(FileManagerFileUploadEventArgs) This member supports the internal infrastructure and is not intended to be used directly from your code.
RaiseVideoSelectorFolderCreating(FileManagerFolderCreateEventArgs) This member supports the internal infrastructure and is not intended to be used directly from your code.
RaiseVideoSelectorItemCopying(FileManagerItemCopyEventArgs) This member supports the internal infrastructure and is not intended to be used directly from your code.
RaiseVideoSelectorItemDeleting(FileManagerItemDeleteEventArgs) This member supports the internal infrastructure and is not intended to be used directly from your code.
RaiseVideoSelectorItemMoving(FileManagerItemMoveEventArgs) This member supports the internal infrastructure and is not intended to be used directly from your code.
RaiseVideoSelectorItemRenaming(FileManagerItemRenameEventArgs) This member supports the internal infrastructure and is not intended to be used directly from your code.
RedirectOnCallback(String) static Redirects a client to a new URL while processing a callback. Inherited from ASPxWebControl.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
RegisterBaseScript(Page) static Registers base scripts, required to embed an ASPxWebControl control onto the specified page. Inherited from ASPxWebControl.
RegisterBaseScript(Page, Boolean) static Registers base scripts required to embed an ASPxWebControl control onto the specified page. Inherited from ASPxWebControl.
RegisterClientIncludeScripts() For internal use only. Inherited from ASPxWebControl.
RegisterClientScriptBlocks() For internal use only. Inherited from ASPxWebControl.
RegisterClientScripts() For internal use only. Inherited from ASPxWebControl.
RegisterStyleSheets() For internal use only.
RegisterUtilsScript(Page) static Obsolete. Registers utils scripts required to embed an ASPxWebControl control onto the specified page. Inherited from ASPxWebControl.
RemovedControl(Control) protected Called after a child control is removed from the Controls collection of the Control object. Inherited from Control.
RenderBeginTag(HtmlTextWriter) Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers. Inherited from WebControl.
RenderChildren(HtmlTextWriter) protected Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client. Inherited from Control.
RenderContents(HtmlTextWriter) protected Renders the contents of the control to the specified writer. This method is used primarily by control developers. Inherited from WebControl.
RenderControl(HtmlTextWriter) Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled. Inherited from Control.
RenderControl(HtmlTextWriter, ControlAdapter) protected Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. Inherited from Control.
RenderEndTag(HtmlTextWriter) Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers. Inherited from WebControl.
ReplacePlaceholders(String, Dictionary<String, String>) static Replaces placeholders with the specified values.
ReplacePlaceholders(String, Object) static Replaces placeholders with the specified values.
ReplacePlaceholders(String, String, String, Dictionary<String, String>) static Replaces placeholders with the specified values.
ReplacePlaceholders(String, String, String, Object) static Replaces placeholders with the specified values.
RequireClientLibrariesRegistering() static Specifies whether client library registration is required. Inherited from ASPxWebControl.
ResetViewStateStoringFlag() For internal use only. Inherited from ASPxWebControlBase.
ResolveAdapter() protected Gets the control adapter responsible for rendering the specified control. Inherited from Control.
ResolveClientUrl(String) Gets a URL that can be used by the browser. Inherited from ASPxWebControlBase.
ResolveUrl(String) Converts a URL into one that is usable on the requesting client. Inherited from Control.
SaveControlState() protected Saves any server control state changes that have occurred since the time the page was posted back to the server. Inherited from Control.
SetCallbackErrorMessage(String) static Specifies the message text to be displayed for remote clients when a DevExpress control callback error has occurred. Inherited from ASPxWebControl.
SetClientSideEventHandler(String, String) Defines a handler for the specified client event. Inherited from ASPxWebControl.
SetDefaultBooleanProperty(String, DefaultBoolean, DefaultBoolean) For internal use only. Inherited from ASPxWebControl.
SetDesignModeState(IDictionary) protected Sets design-time data for a control. Inherited from Control.
SetIECompatibilityMode(Int32) static Switches all DevExpress controls on a page to use the specified IE version. Inherited from ASPxWebControl.
SetIECompatibilityMode(Int32, Control) static Obsolete. Switches all DevExpress controls on the specified page to use the specified IE version. Inherited from ASPxWebControl.
SetIECompatibilityModeEdge() static Switches all DevExpress controls on a page to use the latest IE version. Inherited from ASPxWebControl.
SetIECompatibilityModeEdge(Control) static Obsolete. Switches all DevExpress controls on the specified page to use the latest IE version. Inherited from ASPxWebControl.
SetRenderMethodDelegate(RenderMethod) Assigns an event handler delegate to render the server control and its content into its parent control. Inherited from Control.
SetTraceData(Object, Object) Sets trace data for design-time tracing of rendering data, using the trace data key and the trace data value. Inherited from Control.
SetTraceData(Object, Object, Object) Sets trace data for design-time tracing of rendering data, using the traced object, the trace data key, and the trace data value. Inherited from Control.
SetViewStateStoringFlag() For internal use only. Inherited from ASPxWebControlBase.
IAttributeAccessor.GetAttribute(String) Gets an attribute of the Web control with the specified name. Inherited from WebControl.
IAttributeAccessor.SetAttribute(String, String) Sets an attribute of the Web control to the specified name and value. Inherited from WebControl.
IControlDesignerAccessor.GetDesignModeState() For a description of this member, see GetDesignModeState(). Inherited from Control.
IControlDesignerAccessor.SetDesignModeState(IDictionary) For a description of this member, see SetDesignModeState(IDictionary). Inherited from Control.
IControlDesignerAccessor.SetOwnerControl(Control) For a description of this member, see SetOwnerControl(Control). Inherited from Control.
IParserAccessor.AddParsedSubObject(Object) For a description of this member, see AddParsedSubObject(Object). Inherited from Control.
ToString() Returns a string that represents the current object. Inherited from Object.
UseCachedObjects() For internal use ony. Inherited from ASPxWebControl.
Validate() Performs the editor content's validation.

Events

Name Description
AudioFileSaving Allows you to process an uploaded audio file before it is saved to the server.
AudioSelectorCustomThumbnail Occurs each time before a thumbnail or a folder's icon is created in Audio Selector.
AudioSelectorFileUploading Fires before a file is uploaded to the Audio Selector, and allows you to cancel the action.
AudioSelectorFolderCreating Fires on the server side before a folder is created within the Audio Selector and allows you to cancel the action.
AudioSelectorItemCopying Fires before an item is copied within the Audio Selector, and allows you to cancel the action.
AudioSelectorItemDeleting Fires before an item is deleted within the Audio Selector, and allows you to cancel the action.
AudioSelectorItemMoving Fires before an item is moved within the Audio Selector, and allows you to cancel the action.
AudioSelectorItemRenaming Fires before an item is renamed within the Audio Selector, and allows you to cancel the action.
CallbackError static Allows you to handle any server exception that might occur during server-side processing of a callback sent by a DevExpress web control. Inherited from ASPxWebControl.
ClientLayout Enables you to save and restore the previously saved layout of the ASPxHtmlEditor.
CustomDataCallback Fires when a round trip to the server has been initiated by a call to the client ASPxClientHtmlEditor.PerformDataCallback method.
CustomJSProperties Enables you to supply any server data that can then be parsed on the client.
DataBinding Occurs when the server control binds to a data source. Inherited from Control.
Disposed Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested. Inherited from Control.
DocumentSelectorCustomThumbnail Occurs each time before a thumbnail or a folder's icon is created in Document Selector.
DocumentSelectorFileUploading Fires before a file is uploaded to the Document Selector and allows you to cancel the action.
DocumentSelectorFolderCreating Fires on the server side before a folder is created within the Document Selector and allows you to cancel the action.
DocumentSelectorItemCopying Fires before an item is copied within the Document Selector, and allows you to cancel the action.
DocumentSelectorItemDeleting Fires before an item is deleted within the Document Selector, and allows you to cancel the action.
DocumentSelectorItemMoving Fires before an item is moved within the Document Selector, and allows you to cancel the action.
DocumentSelectorItemRenaming Fires before an item is renamed within the Document Selector, and allows you to cancel the action.
FlashFileSaving Allows you to process an uploaded flash file before it is saved to the server.
FlashSelectorCustomThumbnail Occurs each time before a thumbnail or a folder's icon is created in Flash Selector.
FlashSelectorFileUploading Fires before a file is uploaded to the Flash Selector, and allows you to cancel the action.
FlashSelectorFolderCreating Fires on the server side before a folder is created within the Flash Selector and allows you to cancel the action.
FlashSelectorItemCopying Fires before an item is copied within the Flash Selector, and allows you to cancel the action.
FlashSelectorItemDeleting Fires before an item is deleted within the Flash Selector, and allows you to cancel the action.
FlashSelectorItemMoving Fires before an item is moved within the Flash Selector, and allows you to cancel the action.
FlashSelectorItemRenaming Fires before an item is renamed within the Flash Selector, and allows you to cancel the action.
HtmlChanged Occurs after the content of the ASPxHtmlEditor has been changed.
HtmlCorrecting Occurs before the ASPxHtmlEditor's HTML markup is automatically corrected based upon the HTML validation parameters specified.
ImageFileSaving Allows you to process an uploaded image file before it is saved to the server
ImageSelectorCustomThumbnail Occurs each time before a thumbnail or a folder's icon is created in Image Selector.
ImageSelectorFileUploading Fires before a file is uploaded to the Image Selector, and allows you to cancel the action.
ImageSelectorFolderCreating Fires on the server side before a folder is created within the Image Selector and allows you to cancel the action.
ImageSelectorItemCopying Fires before an item is copied within the Image Selector, and allows you to cancel the action.
ImageSelectorItemDeleting Fires before an item is deleted within the Image Selector, and allows you to cancel the action.
ImageSelectorItemMoving Fires before an item is moved within the Image Selector, and allows you to cancel the action.
ImageSelectorItemRenaming Fires before an item is renamed within the Image Selector, and allows you to cancel the action.
Init Occurs when the server control is initialized, which is the first step in its lifecycle. Inherited from Control.
Load Occurs when the server control is loaded into the Page object. Inherited from Control.
PastedImageSaving Allows you to process and save the pasted binary image to the server.
PreRender Occurs after the Control object is loaded but prior to rendering. Inherited from Control.
RtfContentPastingProcessed Raised when the copied/cut RTF content is processed on the server.
SpellCheckerCustomDictionaryLoading Occurs when a custom spell check dictionary is being loaded into a session.
SpellCheckerWordAdded Occurs after a word is added to a custom dictionary.
Unload Occurs when the server control is unloaded from memory. Inherited from Control.
Validation Allows you to specify whether the ASPxHtmlEditor's content is valid.
VideoFileSaving Allows you to process an uploaded video file before it is saved to the server.
VideoSelectorCustomThumbnail Occurs each time before a thumbnail or a folder's icon is created in Video Selector.
VideoSelectorFileUploading Fires before a file is uploaded to the Video Selector, and allows you to cancel the action.
VideoSelectorFolderCreating Fires on the server side before a folder is created within the Video Selector and allows you to cancel the action.
VideoSelectorItemCopying Fires before an item is copied within the Video Selector, and allows you to cancel the action.
VideoSelectorItemDeleting Fires before an item is deleted within the Video Selector, and allows you to cancel the action.
VideoSelectorItemMoving Fires before an item is moved within the Video Selector, and allows you to cancel the action.
VideoSelectorItemRenaming Fires before an item is renamed within the Video Selector, and allows you to cancel the action.
See Also