BarItem.KeyGesture Property

Gets or sets a keyboard combination that can be used to invoke the current bar item’s functionality. This is a dependency property.

Namespace: DevExpress.Xpf.Bars

Assembly: DevExpress.Xpf.Core.v24.2.dll

NuGet Package: DevExpress.Wpf.Core

Declaration

C#

public KeyGesture KeyGesture { get; set; }

VB.NET

Public Property KeyGesture As KeyGesture

Property Value

Type	Description
KeyGesture	A KeyGesture object.

Remarks

When a key combination defined by the KeyGesture property is invoked, the item’s functionality is invoked as follows:

• The command specified by the BarItem.Command property is invoked.
• The BarItem.ItemClick event fires.
• The BarManager.ItemClick event fires.

Example

This example shows how to specify a command and custom short cut for a bar item. A command and short cut are assigned to the item via the Command and KeyGesture properties, respectively. In the example, a bar is docked to the BarContainerControl which is created manually.

Window1.xaml

<dxb:BarManager.Items>                
    <dxb:BarButtonItem Name="btnCut" 
                       Command="ApplicationCommands.Cut" 
                       KeyGesture="CTRL+1" 
                       CommandTarget="{Binding ElementName=textBox}" 
                       Content="{Binding Command.Text, RelativeSource={RelativeSource Self}}"/>
</dxb:BarManager.Items>

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the KeyGesture property.

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.

XAML

how-to-create-supertips-for-bar-items-ribbon-items-and-standard-controls-in-code-and-xaml-e2702/CS/SuperTipForRibbonFromXaml.xaml#L11

<dxb:BarManager.Items>
    <dxb:BarButtonItem Name="bNew" Content="New" Glyph="new-16x16.png" LargeGlyph="new-32x32.png" KeyGesture="Ctrl+N">
        <dxb:BarButtonItem.SuperTip>