BarItem.Command Property

Gets or sets the command to invoke when the bar item is clicked. This is a dependency property.

Namespace: DevExpress.Xpf.Bars

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

Declaration

C#

[Bindable(true)]
public ICommand Command { get; set; }

VB.NET

<Bindable(True)>
Public Property Command As ICommand

Property Value

Type	Description
ICommand	The command to invoke when the bar item is clicked.

Remarks

When invoking the bar item’s functionality, the command is executed first. Then, the BarItem.ItemClick and BarManager.ItemClick events fire.

Use the BarItem.BeforeCommandExecute property to perform actions immediately after an end-user has clicked the button before the Command is executed.

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 BarItem.Command and BarItem.KeyGesture properties, respectively.In the example, a bar is docked to the BarContainerControl which is created manually.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-bind-a-bar-item-to-a-command-and-provide-a-keygesture-for-the-item-e1550.

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 snippets (auto-collected from DevExpress Examples) contain references to the Command 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.

C#

how-to-bind-a-spreadsheet-to-an-ms-sql-server-database-wpf-spreadsheet-t480591/CS/WpfSpreadsheet_BindToDataSource/MainWindow.xaml#L21

<dxb:BarManager.Items>
    <dxb:BarButtonItem x:Name="biFileNew" Command="{Binding FileNew, Mode=OneTime, Source={StaticResource commands}}" />
    <dxb:BarButtonItem x:Name="biFileOpen" Command="{Binding FileOpen, Mode=OneTime, Source={StaticResource commands}}" />

how-to-assign-custom-in-place-editors-to-worksheet-cells-wpf-spreadsheet-t385458/CS/WpfSpreadsheet_CustomCellEditors/MainWindow.xaml#L22

<dxb:BarManager.Items>
    <dxb:BarButtonItem x:Name="biFileNew" Command="{Binding FileNew, Mode=OneTime, Source={StaticResource commands}}" />
    <dxb:BarButtonItem x:Name="biFileOpen" Command="{Binding FileOpen, Mode=OneTime, Source={StaticResource commands}}" />

how-to-handle-the-hyperlink-click-event-to-invoke-the-custom-form-t488029/CS/DXRichEditHyperlinkHandling/MainWindow.xaml#L20

<dxb:BarManager.Items>
    <dxb:BarButtonItem x:Name="biFileNew" Command="{Binding FileNew, Mode=OneTime, Source={StaticResource commands}}" />
    <dxb:BarButtonItem x:Name="biFileOpen" Command="{Binding FileOpen, Mode=OneTime, Source={StaticResource commands}}" />

wpf-spreadsheet-how-to-bind-a-worksheet-to-a-generic-list-or-a-bindinglist-data-source-t484261/CS/DataBindingToListExample/MainWindow.xaml#L16

<dxb:BarManager.Items>
    <dxb:BarButtonItem x:Name="biFileNew" Command="{Binding FileNew, Mode=OneTime, Source={StaticResource commands}}"/>
    <dxb:BarButtonItem x:Name="biFileOpen" Command="{Binding FileOpen, Mode=OneTime, Source={StaticResource commands}}"/>

dxrichedit-for-wpf-table-api-how-to-create-a-multiplication-table-in-code-e3296/CS/MainWindow.xaml#L26

<dxb:BarManager.Items>
    <dxb:BarButtonItem Command="{Binding Path=FileNew, Mode=OneTime, Source={StaticResource commands}}" Name="biFileNew" />
    <dxb:BarButtonItem Command="{Binding Path=FileOpen, Mode=OneTime, Source={StaticResource commands}}" Name="biFileOpen" />

VB.NET

dxrichedit-for-wpf-how-to-customize-the-hover-menu-e2753/VB/DXRichEdit_HoverMenu/MainWindow.xaml.vb#L35

Dim bLink As BarItemLink = CType(e.Menu.ItemLinks(i), BarItemLink)
Dim cmd As RichEditUICommand = CType(bLink.Item.Command, RichEditUICommand)
If cmd.CommandId = RichEditCommandId.DecreaseIndent OrElse cmd.CommandId = RichEditCommandId.IncreaseIndent Then

how-to-customize-the-popup-menu-t612865/VB/PopupMenuShowing/MainWindow.xaml.vb#L32

barButtonItem.Content = "Save As..."
barButtonItem.Command = viewer.SaveAsCommand
Dim insertBarButtonItem As New InsertAction()