EventToCommand.PassEventArgsToCommand Property

Gets or sets whether the event arguments are passed to the command. This is a dependency property.

Namespace: DevExpress.Mvvm.UI

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

NuGet Package: DevExpress.Wpf.Core

Declaration

C#

public bool? PassEventArgsToCommand { get; set; }

VB.NET

Public Property PassEventArgsToCommand As Boolean?

Property Value

Type	Default	Description
Nullable<Boolean>	false	true to pass the event arguments to the command; otherwise, false.

Remarks

The EventToCommand behavior allows you to pass event arguments to a command. Set the PassEventArgsToCommand property to true:

XAML

<ListBox>
    <dxmvvm:Interaction.Behaviors>
        <dxmvvm:EventToCommand EventName="MouseDoubleClick" 
                               Command="{Binding EditCommand}" 
                               PassEventArgsToCommand="True"/>
    </dxmvvm:Interaction.Behaviors>
</ListBox>

C#

public class MainViewModel : ViewModelBase {
    [Command]
    public void Edit(MouseButtonEventArgs parameter) {
        // ...
    }
}

VB.NET

Public Class MainViewModel
    Inherits ViewModelBase

    <Command>
    Public Sub Edit(ByVal parameter As MouseButtonEventArgs)
        ' ...
    End Sub
End Class

You can also use the EventArgsConverter if you need to maintain a clean MVVM pattern.

Related GitHub Examples

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

wpf-scheduler-process-appointment-drag-drop-resize-operations/CS/SchedulerDragDropResizeExample/MainWindow.xaml#L43

                       Command="{Binding OnDragAppointmentOverCommand}"
                       PassEventArgsToCommand="True" />
<dxmvvm:EventToCommand EventName="DropAppointment"

reporting-wpf-mvvm-how-to-validate-editing-fields/CS/MainWindow.xaml#L17

<dxmvvm:EventToCommand Event="{x:Static dxp:DocumentPreviewControl.ShowingEditingFieldEditorEvent}"
                       PassEventArgsToCommand="True"
                       Command="{Binding OnShowingEditingFieldEditorCommand}" />

wpf-lookupedit-process-new-values/CS/HowToCreateLookUpEdit/MainWindow.xaml#L41

Command="{Binding ShowProductFormCommand}"
PassEventArgsToCommand="True"
SourceName="lookUpEdit">

wpf-pivot-grid-obtain-underlying-data/CS/ObtainUnderlyingData/MainWindow.xaml#L54

EventName="MouseDoubleClick"
PassEventArgsToCommand="True">
<dxmvvm:EventToCommand.EventArgsConverter>

wpf-dashboard-how-to-embed-devexpress-control/CS/GanttSample/Window.xaml#L34

<dxmvvm:Interaction.Behaviors>
    <dxmvvm:EventToCommand EventName="SizeChanged" Command="{Binding OnSizeChangedCommand}" PassEventArgsToCommand="True"></dxmvvm:EventToCommand>
</dxmvvm:Interaction.Behaviors>