Skip to main content

ASPxClientHtmlEditor.CustomCommand Event

Enables you to implement a custom command’s logic.


CustomCommand: ASPxClientEvent<ASPxClientHtmlEditorCommandEventHandler<ASPxClientHtmlEditor>>

Event Data

The CustomCommand event's data class is ASPxClientHtmlEditorCommandEventArgs. The following properties provide information specific to this event:

Property Description
commandName Gets the name of the processed command.
parameter Gets an optional parameter that complements the processed command.


The CustomCommand event occurs on the client side when executing a command whose name (returned by the ASPxClientHtmlEditorCommandEventArgs.commandName property) doesn’t coincide with any default command names listed by the ASPxClientCommandConsts object’s constants.

Handle the CustomCommand event to implement the required logic for the executed custom command. You can, for instance, manually execute a set of default commands by handling this event.


The example below demonstrates how to manipulate ASPxHtmlEditor View Areas by CustomToolbarButton.

function OnCustomCommand(s, e) {
    if(e.commandName == "close") {
    if(e.commandName == "open" || e.commandName == "new")
        if(confirm("Are you sure?"))
<dx:ASPxCallbackPanel ID="cp" runat="server" ClientInstanceName="cp" OnCallback="cp_Callback">
        <dx:PanelContent ID="PanelContent1" runat="server" SupportsDisabledAttribute="True">
            <dx:ASPxHtmlEditor ID="htmlEditor" runat="server">
                <ClientSideEvents CustomCommand="OnCustomCommand" />
                            <dx:CustomToolbarButton CommandName="new" Text="New" />
                            <dx:CustomToolbarButton CommandName="open" Text="Open" />
                            <dx:CustomToolbarButton CommandName="save" Text="Save" />
                            <dx:CustomToolbarButton CommandName="close" Text="Close" />
protected void Page_Load(object sender, EventArgs e) {
    if(!IsPostBack && !IsCallback)
        Session["ViewVisible"] = false;
    if(Session["ViewVisible"]!=null) {
            htmlEditor.Settings.AllowHtmlView = (bool)Session["ViewVisible"];
            htmlEditor.Settings.AllowPreview = (bool)Session["ViewVisible"];
protected void cp_Callback(object sender, DevExpress.Web.ASPxClasses.CallbackEventArgsBase e) {
    if(e.Parameter == "opened") {
        htmlEditor.Settings.AllowHtmlView = true;
        htmlEditor.Settings.AllowPreview = true;
        Session["ViewVisible"] = true;
    if(e.Parameter == "closed") {
        htmlEditor.Settings.AllowHtmlView = false;
        htmlEditor.Settings.AllowPreview = false;
        Session["ViewVisible"] = false;
See Also