[Expand]General Information
[Expand]WinForms Controls
[Collapse]ASP.NET Controls and MVC Extensions
 [Expand]Prerequisites
 [Expand]What's Installed
 [Expand]Common Concepts
 [Expand]ASP.NET WebForms Controls
 [Expand]ASP.NET MVC Extensions
 [Expand]Localization
 [Expand]Redistribution and Deployment
  Get More Help
 [Collapse]API Reference
  [Expand]DevExpress.Data.Linq
  [Expand]DevExpress.Web
  [Expand]DevExpress.Web.ASPxGauges
  [Expand]DevExpress.Web.ASPxGauges.Base
  [Expand]DevExpress.Web.ASPxGauges.Scripts
  [Expand]DevExpress.Web.ASPxHtmlEditor
  [Expand]DevExpress.Web.ASPxHtmlEditor.Localization
  [Collapse]DevExpress.Web.ASPxHtmlEditor.Scripts
   [Expand]ASPxClientCommandConsts Class
   [Collapse]ASPxClientHtmlEditor Class
     ASPxClientHtmlEditor Members
     ASPxClientHtmlEditor Constructor
    [Expand]ASPxClientHtmlEditor Events
    [Collapse]ASPxClientHtmlEditor Methods
     [Expand]Cast Method
      CreateChangeMediaElementCommandArguments Method
      CustomDialogComplete Method
      ExecuteCommand Method
      Focus Method
      GetActiveTabName Method
      GetContextMenu Method
      GetDesignViewDocument Method
      GetDialogPopupControl Method
      GetEnabled Method
      GetErrorText Method
      GetHtml Method
      GetIsValid Method
      GetPreviewDocument Method
      GetRibbon Method
      GetSelection Method
      GetToolbarByName Method
     [Expand]HighlightText Method
      PerformDataCallback Method
      ReconnectToExternalRibbon Method
      ReplacePlaceholders Method
      RestoreSelection Method
      SaveToUndoHistory Method
      SetActiveTabByName Method
      SetEnabled Method
      SetErrorText Method
     [Expand]SetHtml Method
      SetIsValid Method
      SetRibbonContextTabCategoryVisible Method
      SetToolbarComboBoxValue Method
      SetToolbarDropDownItemPickerValue Method
      Validate Method
   [Expand]ASPxClientHtmlEditorAudioDialog Class
   [Expand]ASPxClientHtmlEditorBeforePasteEventArgs Class
    ASPxClientHtmlEditorBeforePasteEventHandler Delegate
   [Expand]ASPxClientHtmlEditorChangeAudioCommandArguments Class
   [Expand]ASPxClientHtmlEditorChangeElementPropertiesDialog Class
   [Expand]ASPxClientHtmlEditorChangeFlashCommandArguments Class
   [Expand]ASPxClientHtmlEditorChangeHtml5MediaElementCommandArguments Class
   [Expand]ASPxClientHtmlEditorChangeImageCommandArguments Class
   [Expand]ASPxClientHtmlEditorChangeMediaElementCommandArguments Class
   [Expand]ASPxClientHtmlEditorChangeVideoCommandArguments Class
   [Expand]ASPxClientHtmlEditorChangeYouTubeVideoCommandArguments Class
   [Expand]ASPxClientHtmlEditorCommandArguments Class
   [Expand]ASPxClientHtmlEditorCommandEventArgs Class
    ASPxClientHtmlEditorCommandEventHandler Delegate
   [Expand]ASPxClientHtmlEditorCommandExecutingEventArgs Class
    ASPxClientHtmlEditorCommandExecutingEventHandler Delegate
   [Expand]ASPxClientHtmlEditorCommandStyleSettings Class
   [Expand]ASPxClientHtmlEditorCustomDialogClosedEventArgs Class
    ASPxClientHtmlEditorCustomDialogClosedEventHandler Delegate
   [Expand]ASPxClientHtmlEditorCustomDialogCloseEventArgsBase Class
   [Expand]ASPxClientHtmlEditorCustomDialogClosingEventArgs Class
    ASPxClientHtmlEditorCustomDialogClosingEventHandler Delegate
   [Expand]ASPxClientHtmlEditorCustomDialogEventArgs Class
    ASPxClientHtmlEditorCustomDialogEventHandler Delegate
   [Expand]ASPxClientHtmlEditorDialogBase Class
   [Expand]ASPxClientHtmlEditorDialogClosedEventArgs Class
    ASPxClientHtmlEditorDialogClosedEventHandler Delegate
   [Expand]ASPxClientHtmlEditorDialogCloseEventArgs Class
   [Expand]ASPxClientHtmlEditorDialogClosingEventArgs Class
    ASPxClientHtmlEditorDialogClosingEventHandler Delegate
   [Expand]ASPxClientHtmlEditorDialogInitializedEventArgs Class
    ASPxClientHtmlEditorDialogInitializedEventHandler Delegate
   [Expand]ASPxClientHtmlEditorEditElementDialog Class
   [Expand]ASPxClientHtmlEditorFlashDialog Class
   [Expand]ASPxClientHtmlEditorImageDialog Class
   [Expand]ASPxClientHtmlEditorInsertAudioCommandArguments Class
   [Expand]ASPxClientHtmlEditorInsertFlashCommandArguments Class
   [Expand]ASPxClientHtmlEditorInsertImageCommandArguments Class
   [Expand]ASPxClientHtmlEditorInsertLinkCommandArguments Class
   [Expand]ASPxClientHtmlEditorInsertTableCommandArguments Class
   [Expand]ASPxClientHtmlEditorInsertTableDialog Class
   [Expand]ASPxClientHtmlEditorInsertVideoCommandArguments Class
   [Expand]ASPxClientHtmlEditorInsertYouTubeVideoCommandArguments Class
   [Expand]ASPxClientHtmlEditorLinkDialog Class
   [Expand]ASPxClientHtmlEditorMediaDialogBase Class
   [Expand]ASPxClientHtmlEditorMediaPreloadMode Class
   [Expand]ASPxClientHtmlEditorPasteFromWordDialog Class
   [Expand]ASPxClientHtmlEditorPlaceholderDialog Class
   [Expand]ASPxClientHtmlEditorSelection Class
   [Expand]ASPxClientHtmlEditorTabCancelEventArgs Class
    ASPxClientHtmlEditorTabCancelEventHandler Delegate
   [Expand]ASPxClientHtmlEditorTabEventArgs Class
    ASPxClientHtmlEditorTabEventHandler Delegate
   [Expand]ASPxClientHtmlEditorTableCellPropertiesCommandArguments Class
   [Expand]ASPxClientHtmlEditorTableCellPropertiesDialog Class
   [Expand]ASPxClientHtmlEditorTableColumnPropertiesCommandArguments Class
   [Expand]ASPxClientHtmlEditorTableColumnPropertiesDialog Class
   [Expand]ASPxClientHtmlEditorTableDialog Class
   [Expand]ASPxClientHtmlEditorTableDialogBase Class
   [Expand]ASPxClientHtmlEditorTableElementPropertiesDialog Class
   [Expand]ASPxClientHtmlEditorTablePropertiesCommandArguments Class
   [Expand]ASPxClientHtmlEditorTableRowPropertiesCommandArguments Class
   [Expand]ASPxClientHtmlEditorTableRowPropertiesDialog Class
   [Expand]ASPxClientHtmlEditorValidationEventArgs Class
    ASPxClientHtmlEditorValidationEventHandler Delegate
   [Expand]ASPxClientHtmlEditorVideoDialog Class
   [Expand]ASPxClientHtmlEditorYouTubeDialog Class
  [Expand]DevExpress.Web.ASPxPivotGrid
  [Expand]DevExpress.Web.ASPxPivotGrid.Data
  [Expand]DevExpress.Web.ASPxPivotGrid.HtmlControls
  [Expand]DevExpress.Web.ASPxPivotGrid.Scripts
  [Expand]DevExpress.Web.ASPxRichEdit
  [Expand]DevExpress.Web.ASPxRichEdit.Localization
  [Expand]DevExpress.Web.ASPxRichEdit.Scripts
  [Expand]DevExpress.Web.ASPxScheduler
  [Expand]DevExpress.Web.ASPxScheduler.Commands
  [Expand]DevExpress.Web.ASPxScheduler.Commands.Dialogs
  [Expand]DevExpress.Web.ASPxScheduler.Controls
  [Expand]DevExpress.Web.ASPxScheduler.Dialogs
  [Expand]DevExpress.Web.ASPxScheduler.Drawing
  [Expand]DevExpress.Web.ASPxScheduler.Localization
  [Expand]DevExpress.Web.ASPxScheduler.Reporting
  [Expand]DevExpress.Web.ASPxScheduler.Scripts
  [Expand]DevExpress.Web.ASPxSpellChecker
  [Expand]DevExpress.Web.ASPxSpellChecker.Localization
  [Expand]DevExpress.Web.ASPxSpellChecker.Scripts
  [Expand]DevExpress.Web.ASPxSpreadsheet
  [Expand]DevExpress.Web.ASPxSpreadsheet.Localization
  [Expand]DevExpress.Web.ASPxSpreadsheet.Scripts
  [Expand]DevExpress.Web.ASPxTreeList
  [Expand]DevExpress.Web.ASPxTreeList.Internal
  [Expand]DevExpress.Web.ASPxTreeList.Localization
  [Expand]DevExpress.Web.ASPxTreeList.Scripts
  [Expand]DevExpress.Web.Captcha
  [Expand]DevExpress.Web.Data
  [Expand]DevExpress.Web.Internal
  [Expand]DevExpress.Web.Localization
  [Expand]DevExpress.Web.Mvc
  [Expand]DevExpress.Web.Mvc.BinderSettings
  [Expand]DevExpress.Web.Mvc.Controllers
  [Expand]DevExpress.Web.MVC.Scripts
  [Expand]DevExpress.Web.Mvc.UI
  [Expand]DevExpress.Web.Office
  [Expand]DevExpress.Web.Office.Internal
  [Expand]DevExpress.Web.Rendering
  [Expand]DevExpress.Web.Scripts
  [Expand]DevExpress.XtraCharts.Web
  [Expand]DevExpress.XtraCharts.Web.Designer
  [Expand]DevExpress.XtraCharts.Web.Scripts
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Office File API
[Expand]Reporting
[Expand]Report and Dashboard Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation
View this topic on docs.devexpress.com (Learn more)

ASPxClientHtmlEditor.ExecuteCommand Method

Executes the specified command.

Namespace:DevExpress.Web.ASPxHtmlEditor.Scripts
Assembly:JavaScript

Expanded Syntax

Parameters

commandName
Type: String
A string value that specifies the command to perform.
parameter
Type: Object
A string value specifying additional information about the command to perform.
addToUndoHistory
Type: Boolean
true, to add the specified command to the undo stack; otherwise, false.

Return value

Type: Boolean
true, if the specified command has been completed successfully; otherwise, false.

Expanded Remarks

Use the ExecuteCommand method to execute either a default or custom command on the client side. Additional information about the command may be specified by using the parameter parameter.

If you need to execute a default command, set the commandName parameter to the value of the corresponding client constant, accessed through the ASPxClientCommandConsts object and pass the corresponding parameter. For example, if you set the commandName to the ASPxClientCommandConsts.FONTNAME_COMMAND constant value, and pass "Verdana" as the parameter, you will change the selected text's font type to Verdana.

To execute a custom command, pass the commandName parameter a value that isn't listed by any constant of the ASPxClientCommandConsts object. You can optionally append a parameter to a custom command by separating them with a semicolon (<command>;<parameter>). After that, the parameter passed as parameter is ignored. For custom commands, the ASPxHtmlEditor generates the CustomCommand client event, allowing you to implement your custom command logic.

Expanded Example

Show Me

A complete sample project is available in the DevExpress Code Examples database at http://www.devexpress.com/example=T283558.

ASPxHtmlEditor allows you to provide custom toolbar buttons and modify the functionality of default buttons.

In this example, two custom buttons and corresponding shortcuts are created: Clear and Add Signature. When a button is clicked or shortcut is pressed, the CustomCommand event is triggered. In the event handler, the default select all and delete commands are executed using the ExecuteCommand method.

Additionally, we have modified the functionality of the default insert ordered list command. In the CommandExecuted event handler, which is triggered after the command is processed, we change the type of ordered list markers to Roman numerals.

Expanded See Also

Is this topic helpful?​​​​​​​