CommandItem Class

A command that the CompositeCommandBehavior aggregates to create a composite command.

Namespace: DevExpress.Mvvm.UI

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

NuGet Package: DevExpress.Wpf.Core

Declaration

C#

public class CommandItem :
    DependencyObjectExt

VB.NET

Public Class CommandItem
    Inherits DependencyObjectExt

Remarks

Each CommandItem should contain the Command property that is the ICommand that the behavior should aggregate.

In the following code sample, the CompositeCommandBehavior takes two CommandItems, aggregates them to the CompositeCommand, and executes it when a user clicks the ThemedWindow‘s back button:

MainWindow.xaml

<dx:ThemedWindow ...
    xmlns:dx="http://schemas.devexpress.com/winfx/2008/xaml/core"
    xmlns:ViewModels="clr-namespace:CompositeCommandCommandPropertyName.ViewModels"
    xmlns:dxmvvm="http://schemas.devexpress.com/winfx/2008/xaml/mvvm"
    ShowBackButton="True">
    <dx:ThemedWindow.DataContext>
        <ViewModels:MainViewModel/>
    </dx:ThemedWindow.DataContext>
    <dxmvvm:Interaction.Behaviors>
        <dxmvvm:CompositeCommandBehavior CommandPropertyName="NavigateBackCommand">
            <dxmvvm:CommandItem Command="{Binding SaveCommand}"/>
            <dxmvvm:CommandItem Command="{Binding CloseCommand}"/>
        </dxmvvm:CompositeCommandBehavior>
    </dxmvvm:Interaction.Behaviors>
    <!-- ... -->
</dx:ThemedWindow>

MainViewModel.cs

using DevExpress.Mvvm;
using DevExpress.Mvvm.DataAnnotations;
using System.Windows;

public partial class MainViewModel : ViewModelBase {

    [Command]
    public void Save()
    {
      // ...
    }

    [Command]
    public void Close()
    {
      // ...
    }
}

MainViewModel.vb

Imports DevExpress.Mvvm
Imports DevExpress.Mvvm.DataAnnotations
Imports System.Windows

Public Partial Class MainViewModel
    Inherits ViewModelBase

    <Command>
    Public Sub Save()
        ' ...
    End Sub

    <Command>
    Public Sub Close()
        ' ...
    End Sub
End Class

Related GitHub Examples

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

XAML

wpf-bind-gridcontrol-to-dynamic-data/CS/ExpandoObject/MainWindow.xaml#L28

<dxmvvm:CompositeCommandBehavior>
    <dxmvvm:CommandItem Command="{Binding AddColumnCommand}" />
    <dxmvvm:CommandItem Command="{DXCommand '@e(Grid).PopulateColumns()'}" />

wpf-scheduler-create-regular-and-recurring-appointments-at-view-model-level/CS/DXApplication14/MainWindow.xaml#L22

<dxmvvm:CompositeCommandBehavior CanExecuteCondition="AnyCommandCanBeExecuted">
    <dxmvvm:CommandItem Command="{Binding AddApptCommand}"
                        CommandParameter="false" />

wpf-data-grid-specify-row-visibility-in-viewmodel/CS/CustomFilteringMVVM/MainWindow.xaml#L42

<dxmvvm:CompositeCommandBehavior>
    <dxmvvm:CommandItem Command="{Binding AddExclusionCommand}"/>
    <dxmvvm:CommandItem Command="{DXCommand Execute='@e(grid).RefreshData()'}" />

Inheritance

Object

DispatcherObject

DependencyObject

Freezable

DevExpress.Mvvm.UI.Native.DependencyObjectExt

CommandItem