RichEditControl.AssignShortcutKeyToCommand(Keys, Keys, RichEditCommandId) Method
Assigns a shortcut key to a command. The shortcut key is available for all RichEdit views.
Namespace: DevExpress.XtraRichEdit
Assembly: DevExpress.XtraRichEdit.v19.1.dll
Declaration
public void AssignShortcutKeyToCommand(
Keys key,
Keys modifier,
RichEditCommandId commandId
)
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. |
Remarks
To remove a command shortcut, use the RichEditControl.RemoveShortcutKey method.
Example
The following code assigns Ctrl+G shortcut to the ToggleShowWhitespaceCommand command and removes predefined Ctrl+N shortcut so that it is no longer in use.
Note
A complete sample project is available at https://github.com/DevExpress-Examples/winforms-the-richeditcontrols-common-api-t210437
richEditControl.Text = "Use 'Ctrl+G' shortcut to show/hide whitespace characters";
richEditControl.Text += "\r\nA new document can not be created by pressing 'Ctrl+N' shortcut since this shortcut is disabled";
richEditControl.AssignShortcutKeyToCommand(System.Windows.Forms.Keys.Control, System.Windows.Forms.Keys.G, RichEditCommandId.ToggleShowWhitespace);
richEditControl.RemoveShortcutKey(System.Windows.Forms.Keys.Control, System.Windows.Forms.Keys.N);
Related GitHub Examples
The following code snippets (auto-collected from DevExpress Examples) contain references to the AssignShortcutKeyToCommand(Keys, Keys, RichEditCommandId) method.
Note
The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.