RichEditControl.AssignShortcutKeyToCommand(Keys, Keys, RichEditCommandId, Boolean) Method

Assigns a shortcut key to a command. Shortcut key is available for all RichEdit views.

Namespace: DevExpress.Xpf.RichEdit

Assembly: DevExpress.Xpf.RichEdit.v24.1.dll

NuGet Package: DevExpress.Wpf.RichEdit

Declaration

C#

public void AssignShortcutKeyToCommand(
    Keys key,
    Keys modifier,
    RichEditCommandId commandId,
    bool updateToolTip
)

VB.NET

Public Sub AssignShortcutKeyToCommand(
    key As Keys,
    modifier As Keys,
    commandId As RichEditCommandId,
    updateToolTip As Boolean
)

Parameters

Name	Type	Description
key	Keys	A Keys enumeration member specifying a key to assign.
modifier	Keys	A Keys enumeration member specifying a modifier key.
commandId	RichEditCommandId	A RichEditCommandId enumeration member specifying a command.
updateToolTip	Boolean	true to modify a tooltip of the BarItem to which a command is assigned; otherwise, false.

Remarks

The AssignShortcutKeyToCommand method override enables you to modify a tooltip of the bar item (the BarItem.SuperTip property) in the RichEdit UI so that it displays the correct shortcut information. To do this, set the updateToolTip parameter to true.

Note that the RichEditControl’s shortcuts should be assigned after the control is initialized (e.g. in the Window.Loaded event handler).

Note

If the command already has a shortcut, the AssignShortcutKeyToCommand method does not change the related tooltip. The tooltip will show the previously assigned shortcut.

The code sample below assigns the Alt+Y shortcut to the CreateFieldCommand, allowing you to insert a field:

C#

private void ThemedWindow_Loaded(object sender, System.Windows.RoutedEventArgs e)
{
  richEditControl1.AssignShortcutKeyToCommand(Keys.Y, Keys.Alt, RichEditCommandId.CreateField, true);
}

VB.NET

Private Sub ThemedWindow_Loaded(ByVal sender As Object, ByVal e As System.Windows.RoutedEventArgs)
   richEditControl1.AssignShortcutKeyToCommand(Keys.Y, Keys.Alt, RichEditCommandId.CreateField, True)
End Sub

To remove a command shortcut, use the RichEditControl.RemoveShortcutKey method.