Keyboard Shortcuts

• Jan 20, 2022
• 3 minutes to read

A keyboard shortcut is a set of one or more keys that invokes a dialog or executes a command when a user presses this set. The HtmlEditorShortcut class implements the shortcut functionality. The HtmlEditorShortcutCollection object stores a collection of shortcuts. To access this object, use the ASPxHtmlEditor.Shortcuts property.

Default Shortcuts

ASPxHtmlEditor has the following shortcuts:

Shortcut Design-time Customization

ASPxHtmlEditor allows you to redefine default shortcuts and create custom shortcuts at design time in two ways.

• Using an ASPxHtmlEditor Designer

• Directly in markup

Shortcut Runtime Customization

ASPxHtmlEditor allows you to use the HtmlEditorShortcutCollection class methods to modify a shortcut collection at runtime.

The code sample below demonstrates how to modify a shortcut collection at runtime. The first shortcut invokes a MyDialog custom dialog. The second shortcut redefines a default Ctrl+B shortcut. The third shortcut assigns the default command bold to a custom shortcut.

Note that other default shortcuts (except Ctrl+B) are still in effect.

• ASPX

<dx:ASPxHtmlEditor ID="MyHtmlEditor" runat="server">
     <CustomDialogs>
          <dx:HtmlEditorCustomDialog Caption="My Custom Dialog" 
          FormPath="~/CustomDialogs/MyCustomDialog1.ascx" Name="MyDialog" />
     </CustomDialogs>
</dx:ASPxHtmlEditor>

• C#
• VB.NET

using DevExpress.Web.ASPxHtmlEditor;

...

protected void Page_Load(object sender, EventArgs e) {
     if (!IsPostBack) {
          MyHtmlEditor.Shortcuts.Add("Ctrl+D", "MyDialog", ActionType.ShowCustomDialog);
          MyHtmlEditor.Shortcuts.Add("Ctrl+B", "backcolor");
          MyHtmlEditor.Shortcuts.Add("Alt+B", "bold");
     }
}

Imports DevExpress.Web.ASPxHtmlEditor
...
Protected Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
    If Not IsPostBack Then
        MyHtmlEditor.Shortcuts.Add("Ctrl+D", "MyDialog", ActionType.ShowCustomDialog)
        MyHtmlEditor.Shortcuts.Add("Ctrl+B", "backcolor")
        MyHtmlEditor.Shortcuts.Add("Alt+B", "bold")
    End If
End Sub