ViewModelでイベントハンドラーを記述したい。あるいはPrism的なイベントハンドラー記述方法を知りたい

Question

開発環境

C#でWPFアプリケーションを作成中
Visual Studio 2019
使用しているMVVMパッケージ Prism

質問のポイント

Prismらしいイベントハンドラーの記述方法が知りたい。特にsenderなどの情報を利用するためのDelegateCommand宣言方法を知りたい。

前提：知っている情報（イベントハンドラー）

コードビハインドにイベントハンドラーの本体を書き、XAMLでEventSetterを使えばイベントを作れることを確認しました。しかし、これはあまりPrism的ではないのではないかとなんとなく感じています。コードビハインドの記述が増えるのも気になります。コードビハインドに記述することなくsenderやeの情報を利用したいところなのですが・・・。

// View.xaml.cs
private void TestEventHandler(object sender, MouseButtonEventArgs e)
{
  Console.WriteLine("test");
  // senderやeの情報利用可能。
}

<!-- View.xaml -->
<Page.Resources>
  <Style TargetType="{x:Type DataGridRow}">
    <EventSetter Event="MouseLeftButtonUp" Handler="TestEventHandler"/>
  </Style>
</Page.Resources>

前提：知っている情報（Prismでのボタンクリックイベント）

DelegateCommandを使えばXAML側のCommandにメソッドをバインディングできることは知っています。

// ViewModel.cs
private DelegateCommand clickEvent;
public DelegateCommand ClickEvent => this.clickEvent ?? (this.clickEvent = new DelegateCommand(this.ExecuteClickEvent));
private void ExecuteClickEvent()
{
  Console.WriteLine("test");
}

<!-- View.xaml -->
<Button Command="{Binding ClickEvent}"/>

本題：知りたい情報（ViewModelでイベントハンドラーを記述したい。あるいはPrism的なイベントハンドラー記述方法を知りたい）

下記は想像で作成したコードですが、例えばこのような方向性ですっきり書く方法はないのでしょうか？

// [注意]推測と想像で作成した動かないコード
// ViewModel.cs
private DelegateCommand(object sender, MouseButtonEventArgs e) eventHandler;
public DelegateCommand(object sender, MouseButtonEventArgs e) ClickEvent => this.clickEvent ?? (this.clickEvent = new DelegateCommand(this.ExecuteClickEvent));
private void ExecuteClickEvent(object sender, MouseButtonEventArgs e)
{
  Console.WriteLine("test");
  // senderやeの情報利用可能。
}

<!-- [注意]推測と想像で作成した動かないコード -->
<!-- View.xaml -->
<Page.Resources>
  <Style TargetType="{x:Type DataGridRow}">
    <EventSetter Event="MouseLeftButtonUp" Handler="TestEventHandler"/>
    <!-- 特に何も指定しなくてもViewModel.cs側でobjectとMouseButtonEventArgsが割り当てられる -->
  </Style>
</Page.Resources>

以上です。WPFとPrismを使ったことがある方の返信をいただけると幸いです。

Comments

[gentaro]

「すっきり」って何を指してるんだろう。Prismのコマンドをバインドする方法の何が「すっきり」してないのか説明しないと理解できないと思うけど。

[Arks]

Prismの常識を詳しく知らないので「すっきり」していないものをそう称していることがあるとお考えください。より「すっきり」しているもの。「Prismならこう書くのが当然でしょう」といった発想があったら教えていただけると発想を修正することができます。もしPrismの常識をご存知でしたら書き方のヒントをいただけるととても助かります。

[gentaro]

ちょっと意味がよくわかんないけど、EventArgsとsenderをViewModelで受け取りたいという質問であれば、同様の質問の回答がここにあります。
https://social.msdn.microsoft.com/Forums/en-US/28d72791-d4c5-47d4-961c-175abd87d2a8/passing-sender-and-eventarguments-with-delegatecommand?forum=wpf

前者はInvokeCommandActionを使い、後者はそもそもMVVMの前提を崩してるからおかしい、という話。

[Arks]

MVVMの原則ではVMはVへの参照を必要としてはいけないようですが、となるとMはどうやってsenderなどの情報を利用するべきなのでしょう。senderなどの情報はVのコードビハインドのみで利用すべきということなのでしょうか。

InvokeCommandActionについても読み込んでみます。

[gentaro]

どういう処理をやろうとしてるのかわかりませんが、MVVMを採用するからコードビハインド書いちゃだめという決まりはないので、必要ならViewのコードビハインドに書けばいいんじゃないでしょうか。
それをやりたくないなら、そもそもViewの要素に依存する設計を変更すればいいだけで、例えばバインドするコマンドそのものを別に用意すれば発生元ごとに処理は分けられると思いますけど。

[Zuishin]

引数は読んで字の如く parameter で渡せます。
https://docs.microsoft.com/ja-jp/dotnet/api/system.windows.input.icommand.execute?view=netframework-4.8#System_Windows_Input_ICommand_Execute_System_Object_

が、e はともかく sender を使わなきゃいけない時点ですっきりしてないので。

[Arks]

InvokeCommandActionを試しています。<i:interaction.Triggers>を使ってコマンドを呼び出すことができるというのはなんとなくわかりましたが、VM側のDelegateCommand定義がいまいちわかりません。senderとeをもたせたいところなのですが、たとえばDelegateCommand<MouseButtonEventArgs e>で定義すると「非ジェネリック 種類'DelegateCommand'は型引数と一緒には使用できません」エラーが発生します。DelegateCommand<MouseButtonEventArgs>として定義すればエラーはでないようですが、DelegateCommand<object, MouseButtonEventArgs>は「非ジェネリック～」エラーが起きます。

コピペで増やすタイプの類似記述は避けたほうが良いというのを聞いたことがあるので、必要な分だけバインドするコマンドを用意するというのはできれば回避したい気はしています。それと下記のケースだとあまり合わないかなと。
たとえばDataGridをクリックしたときにsenderを利用して、クリック直下にあるアイテムのプロパティなどを利用するシーンを思い描いています。senderやeは細かな情報を利用する上で重要かなと考えているのですが、普通senderはあまり利用しないものなのでしょうか。
parameter調べてみます。

[Zuishin]

XAML で CommandParameter で指定したオブジェクトが parameter として渡されます。
<Button Command="{Binding ClickCommand}" CommandParameter="{Binding RelativeSource=...

Answer 1

頂いた情報を元に自己解決しました。

知りたかったことと答え

Prismらしいイベントハンドラーの記述方法が知りたい。特にsenderなどの情報を利用するためのDelegateCommand宣言方法を知りたい。

Prismらしいと思えるような記述が見つかりました。下に記載します。
DelegateCommandの宣言では1つだけパラメーターを持たせることができることがわかりました。senderとEventArgs両方を宣言して利用するということはできません。2つの情報を合わせて1つのobjectに見せかければ渡すことができなくはなさそうです。ただ、PrismのInvokeCommandActionではEventArgsだけを渡す仕組みになっているようです。これに従って工夫することにします。もしどうしても複数の値をメソッドに渡したい場合には「MultiBinding」「MarkupExtensionでBindを拡張する」といったヒントが役に立ちそうです。特にMarkupExtensionについてはここの解説がとても参考になりました。

PrismのInvokeCommandActionを利用した解決策

<!-- View.xaml -->
xmlns:i="http://schemas.microsoft.com/expression/2010/interactivity"
xmlns:prism="http://prismlibrary.com/"

<TextBox>
    <i:Interaction.Triggers>
        <i:EventTrigger EventName="TextChanged">
            <prism:InvokeCommandAction Command="{Binding Command1}"/>
            <!-- i:InvokeCommandActionも存在するが、そちらではEventArgsを渡せない -->
        </i:EventTrigger>
    </i:Interaction.Triggers>
</TextBox>

// ViewModel.cs
private DelegateCommand<EventArgs> command1;
public DelegateCommand<EventArgs> Command1 => this.command1 ?? (this.command1 = new DelegateCommand<EventArgs>(this.ExecuteCommand1));
private void ExecuteCommand1(EventArgs e)
{
    Console.WriteLine(e.ToString());
}

イベントハンドラーをVMで記述する方法を模索しましたが、CommandParameterでVMのメソッドに値を渡せることを知れたので、この手段を使って課題解決を図れるケースも多々あると感じています。アドバイスしていただきありがとうございました。

Comments

[sakizakino]

今後こちらの情報を見た人のために一応書いておきます。
<prism:InvokeCommandAction Command="{Binding Command1}"/>
では、こちらを設定しているTextBoxのIsEnabledのBindingが壊れます。

<i:InvokeCommandAction Command="{Binding Command1}"　PassEventArgsToCommand="True"/>
とすると、TextBoxのIsEnabledのBindingを壊さずにイベント引数をVMに渡せます。

Answer 2

こちらのようですね。同じ事を調べていて助かりました。ありがとうございます。