Data Grid Command API

• Aug 25, 2023
• 4 minutes to read

You can maintain a clean MVVM pattern and define custom logic in a ViewModel. The GridControl includes the following command counterparts for events that expect a return value:

These commands expose UI-independent arguments and pass them to the ViewModel as a typed parameter. As a result, you can modify the command parameter at the ViewModel level and return values to a View:

• Xaml

<dxg:GridControl CustomColumnDisplayTextCommand="{Binding CalculateDisplayTextCommand}" />

• C#
• VB.NET

public class ViewModel: ViewModelBase {
    // ...

    [Command]
    public void CalculateDisplayText(DevExpress.Mvvm.Xpf.CustomColumnDisplayTextArgs args) {
        args.DisplayText = GetLocalizedValue(args.FieldName, args.Value, Language);
    }
}

Public Class ViewModel
    Inherits ViewModelBase

    <Command>
    Public Sub CalculateDisplayText(ByVal args As DevExpress.Mvvm.Xpf.CustomColumnDisplayTextArgs)
        args.DisplayText = GetLocalizedValue(args.FieldName, args.Value, Language)
    End Sub 
End Class

If an event does not have a command counterpart property, you can use the EventToCommand behavior to bind your command to the event. This behavior allows you to pass a parameter to the bound command and return the parameter to the event.

Note

Command counterparts for events do not support Asynchronous Commands.

Built-in Commands

The GridControl includes multiple built-in commands that allow you to expand/collapse group rows, move focus, sort/group data, and so on.

The following classes store these commands:

Refer to these class members to get the full list of available commands.

The code snippet below demonstrates how to use built-in commands:

• XAML

<Button Command="{Binding ElementName=grid,Path=View.Commands.ShowSearchPanel}" />

Custom Commands

You can specify your own commands in a ViewModel. The following help topic illustrates how to create a command that deletes selected rows from the GridControl: Binding to a Collection of Selected Items.