Back to Devexpress

EventToCommand.PassEventArgsToCommand Property

wpf-devexpress-dot-mvvm-dot-ui-dot-eventtocommand.md

latest5.1 KB
Original Source

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.v25.2.dll

NuGet Package : DevExpress.Wpf.Core

Declaration

csharp
public bool? PassEventArgsToCommand { get; set; }
vb
Public Property PassEventArgsToCommand As Boolean?

Property Value

TypeDefaultDescription
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>
csharp
public class MainViewModel : ViewModelBase {
    [Command]
    public void Edit(MouseButtonEventArgs parameter) {
        // ...
    }
}
vb
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.

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.

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

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

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

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

reporting-wpf-drill-through/CS/Viewer/MainWindow.xaml#L36

xml
<dxmvvm:Interaction.Behaviors>
    <dxmvvm:EventToCommand EventName="DocumentPreviewMouseClick" PassEventArgsToCommand="True" Command="{Binding OnPreviewMouseClickCommand}" />
    <dxmvvm:EventToCommand EventName="DocumentPreviewMouseMove" PassEventArgsToCommand="True" Command="{Binding OnPreviewMouseMoveCommand}" />

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

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

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

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

See Also

EventArgsConverter

EventToCommand Class

EventToCommand Members

DevExpress.Mvvm.UI Namespace