ASPxHtmlEditor Class
An HTML text editor control.
Namespace: DevExpress.Web.ASPxHtmlEditor
Assembly: DevExpress.Web.ASPxHtmlEditor.v24.1.dll
NuGet Package: DevExpress.Web
#Declaration
public class ASPxHtmlEditor :
ASPxWebControl,
IRequiresLoadPostDataControl,
IParentSkinOwner,
ISkinOwner,
IPropertiesOwner,
IValidationSummaryEditor,
IControlDesigner,
IStyleSheetManagerImagesProvider
#Related API Members
The following members return ASPxHtmlEditor objects:
#Remarks
The ASPxHtmlEditor class is a visual control that enables non-technical users to easily edit HTML markup as an ordinary rich text document.
#Create an HTML Editor
#Design Time
The ASPxHtmlEditor control is available on the DX.24.1: Common Controls toolbox tab in the Microsoft Visual Studio IDE.
Drag the control onto a form and customize the control’s settings, or paste the control’s markup in the page’s source code.
<dx:ASPxHtmlEditor ID="htmlEditor" runat="server" ActiveView="Html">
<SettingsDialogs>
<InsertImageDialog>
<SettingsImageUpload>
<ValidationSettings AllowedFileExtensions=".jpe,.jpeg,.jpg,.gif,.png" MaxFileSize="500000">
</ValidationSettings>
</SettingsImageUpload>
</InsertImageDialog>
</SettingsDialogs>
</dx:ASPxHtmlEditor>
#Run Time
using DevExpress.Web.ASPxHtmlEditor;
...
protected void Page_Load(object sender, EventArgs e)
{
ASPxHtmlEditor new_htmlEditor = new ASPxHtmlEditor();
new_htmlEditor.ID = "htmlEditor";
Page.Form.Controls.Add(new_htmlEditor);
new_htmlEditor.ActiveView = HtmlEditorView.Html;
string[] extensions = {".jpe", ".jpeg", ".jpg", ".gif", ".png"};
new_htmlEditor.SettingsDialogs.InsertImageDialog.SettingsImageUpload.ValidationSettings.AllowedFileExtensions = extensions;
new_htmlEditor.SettingsDialogs.InsertImageDialog.SettingsImageUpload.ValidationSettings.MaxFileSize = 500000;
}
Note
DevExpress controls require that you register special modules, handlers, and options in the Web.
The ASPxHtmlEditor control provides three view modes.
- Design view allows end-users to modify the editor content using various design tools (such as toolbars and context menu), and instantly see the results.
- Html view allows end-users to modify the editor content using HTML markup.
- Preview allows end-users to view the editor content as a regular webpage.
The active view can be specified using the ASPxHtmlEditor.ActiveView property.
ASPxHtmlEditor allows you to programmatically access the HTML content both on the client and server sides. To learn more, see the Get and Set HTML section.
The appearance of the control and its different elements can be widely customized with the help of specific style and image settings. To learn more, see the Visual Elements section.
Note
Client Functionality The ASPx
- The control’s client-side equivalent is represented by the ASPx
Client object.Html Editor - On the client side, the client object can be accessed directly by the name specified via the ASPx
Html property.Editor. Client Instance Name - The available client events are listed by the ASPx
Html property.Editor. Client Side Events
The client-side API is always available for this control.
To try the ASPxHtmlEditor control functionality, see Online Demos.
#Example
In markup:
Programmatically:
protected void Page_Init(object sender, EventArgs e) {
DevExpress.Web.ASPxHtmlEditor.ASPxHtmlEditor he = new DevExpress.Web.ASPxHtmlEditor.ASPxHtmlEditor();
he.ID = "he1";
Form.Controls.Add(he);
he.Html = "<b>Hello, World</b>";
he.HtmlChanged += new EventHandler<EventArgs>(he_HtmlChanged);
//...
}
void he_HtmlChanged(object sender, EventArgs e) {
//code
}