BackstageButtonItem.Command Property

Gets or sets a command fired when the button item is clicked.

Namespace: DevExpress.Xpf.Ribbon

Assembly: DevExpress.Xpf.Ribbon.v20.2.dll

NuGet Packages: DevExpress.WindowsDesktop.Wpf.Ribbon, DevExpress.Wpf.Navigation

Declaration

C#

public ICommand Command { get; set; }

VB.NET

Public Property Command As ICommand

Property Value

Type	Description
ICommand	A ICommand object, fired when the button item is clicked.

Remarks

You can define an action that will happen when the BackstageButtonItem is clicked by setting the Command property. The command must be defined in Window.CommandBindings section in order to make it reusable for different controls. If the Command is a RoutedCommand, you may want to define the BackstageButtonItem.CommandTarget.

The following code shows an example of binding a predefined Paste command to a button:

XAML

<dxr:BackstageButtonItem Name ="pasteButton" Content="Paste" Command="ApplicationCommands.Paste" CommandTarget="{Binding ElementName=textBox2}" />

C#

pasteButton.Command = ApplicationCommands.Paste;
pasteButton.CommandTarget = textBox2;

To learn more about commands, see the Commanding Overview and ICommand Interface articles in MSDN.

You can also implement an action for a button via the BackstageItemBase.Click event.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference 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.

XAML

how-to-implement-backstagebuttonitem-with-togglebutton-behavior-e4834/CS/Q506373/MainWindow.xaml#L83

<dxr:BackstageButtonItem Content="Regular Button" />
<local:BackstageCheckItem Content="Toggle Button with a command" IsChecked="False" Command="{StaticResource myCommand}"/>
<local:BackstageCheckItem Content="Toggle Button with a command (Close on Toggle)" IsChecked="False" Command="{StaticResource myCommand}" CloseOnToggle="True"/>