BarShortcut Class

Contains item shortcut settings.

Namespace: DevExpress.XtraBars

Assembly: DevExpress.XtraBars.v18.1.dll

Declaration

C#

[TypeConverter("DevExpress.XtraBars.TypeConverters.BarShortcutTypeConverter, DevExpress.XtraBars.v18.1.Design")]
public class BarShortcut

VB.NET

<TypeConverter("DevExpress.XtraBars.TypeConverters.BarShortcutTypeConverter, DevExpress.XtraBars.v18.1.Design")>
Public Class BarShortcut

Related API Members

The following members accept/return BarShortcut objects:

• BarHeaderItem.ItemShortcut
• BarItem.ItemShortcut
• BarItemLink.ItemShortcut
• RibbonGalleryBarItem.ItemShortcut
• ShortcutItemClickEventArgs.Shortcut

Remarks

You can assign shortcuts to each item. This can be done using the BarItem.ItemShortcut property of items. This property is of the BarShortcut type.

Shortcuts specified using the BarShortcut object can contain up to two consecutive key combinations. For instance, you can specify the CTRL+K, CTRL+C sequence to be an item’s shortcut. At design time, the DevExpress Ribbon, Menu and Docking Library provides a convenient shortcut designer that can be used to specify the key sequence directly, by pressing it. See the screenshot below for an example.

At runtime, you need to use one of the BarShortcut constructors to specify shortcut settings.

Note

Do not assign system shortcuts to bar items. For instance, the Ctrl+A shortcut is used to select text in a text box. The Ctrl+C shortcut is used to copy a selected text. The Esc shortcut is used to close dropdown windows. Do not assign these shortcuts and such to bar items. Otherwise, conflicts and unpredictable results may occur.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the BarShortcut class.

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.

C#

how-to-enumerate-buttons-in-a-menu-or-on-a-toolbar-e599/CS/Form1.cs#L299

this.iOpen.ImageIndex = 7;
this.iOpen.ItemShortcut = new DevExpress.XtraBars.BarShortcut((System.Windows.Forms.Keys.Control | System.Windows.Forms.Keys.O));
this.iOpen.Name = "iOpen";

how-to-merge-usercontrols-toolbars-with-the-main-forms-toolbars-e753/CS/UserControl1.cs#L86

this.barButtonItem1.Id = 0;
this.barButtonItem1.ItemShortcut = new DevExpress.XtraBars.BarShortcut((System.Windows.Forms.Keys.Control | System.Windows.Forms.Keys.M));
this.barButtonItem1.Name = "barButtonItem1";

how-to-create-a-table-bar-item-for-ribboncontrol-e4491/CS/testSample/TableBarItem/CustomBarItem/TableBarItem.cs#L40

}
public TableBarItem(BarManager manager, string caption, int imageIndex, BarShortcut shortcut)
    : base(manager, caption, imageIndex, shortcut)

how-to-change-the-shortcut-key-assigned-to-a-command-e2857/CS/CommandShortcutChange/Form1.cs#L32

    if (item.GetType() == typeof(DevExpress.XtraRichEdit.UI.ToggleShowWhitespaceItem))
        item.ItemShortcut = new DevExpress.XtraBars.BarShortcut((Keys.Control | Keys.G));
}

how-to-implement-a-shortcut-functionality-for-the-simplebutton-e1608/CS/S92027/MySimpleButton.cs#L25

if (manager == null || shortcut == Keys.None) return;
int item = manager.Items.Add(new BarButtonItem(manager, string.Concat("bbi_", Name), -1, new BarShortcut(Shortcut)));
manager.Items[item].ItemClick += new ItemClickEventHandler(OnBarButtonItemItemClick);

VB.NET

how-to-enumerate-buttons-in-a-menu-or-on-a-toolbar-e599/VB/Form1.vb#L223

Me.iOpen.ImageIndex = 7
Me.iOpen.ItemShortcut = New DevExpress.XtraBars.BarShortcut((System.Windows.Forms.Keys.Control Or System.Windows.Forms.Keys.O))
Me.iOpen.Name = "iOpen"

how-to-merge-usercontrols-toolbars-with-the-main-forms-toolbars-e753/VB/UserControl1.vb#L85

Me.barButtonItem1.Id = 0
Me.barButtonItem1.ItemShortcut = New DevExpress.XtraBars.BarShortcut((System.Windows.Forms.Keys.Control Or System.Windows.Forms.Keys.M))
Me.barButtonItem1.Name = "barButtonItem1"

how-to-create-a-table-bar-item-for-ribboncontrol-e4491/VB/testSample/TableBarItem/CustomBarItem/TableBarItem.vb#L36

End Sub
Public Sub New(ByVal manager As BarManager, ByVal caption As String, ByVal imageIndex As Integer, ByVal shortcut As BarShortcut)
    MyBase.New(manager, caption, imageIndex, shortcut)

how-to-change-the-shortcut-key-assigned-to-a-command-e2857/VB/CommandShortcutChange/Form1.vb#L30

If item.GetType() Is GetType(DevExpress.XtraRichEdit.UI.ToggleShowWhitespaceItem) Then
    item.ItemShortcut = New DevExpress.XtraBars.BarShortcut((Keys.Control Or Keys.G))
End If

how-to-implement-a-shortcut-functionality-for-the-simplebutton-e1608/VB/S92027/MySimpleButton.vb#L39

End If
Dim item As Integer = manager_Renamed.Items.Add(New BarButtonItem(manager_Renamed, String.Concat("bbi_", Name), -1, New BarShortcut(Shortcut)))
AddHandler manager_Renamed.Items(item).ItemClick, AddressOf OnBarButtonItemItemClick

Inheritance

Object

BarShortcut