使用 Microsoft.Xaml.Behaviors 在 WPF 中处理命令和事件参数
在 WPF 应用程序中，我们经常需要在 MVVM 模式下处理用户交互，同时传递both事件参数和当前的数据上下文。Microsoft.Xaml.Behaviors 提供了一种优雅的方式来实现这一目标。本笔记将详细介绍如何使用 EventTrigger、InvokeCommandAction 以及自定义的 EventArgsConverter 来实现这一功能。
1. XAML 配置
首先，在 XAML 中添加 Microsoft.Xaml.Behaviors 的命名空间：
xmlns:i="http://schemas.microsoft.com/xaml/behaviors"
然后，使用 EventTrigger 和 InvokeCommandAction 来绑定事件和命令：
<i:Interaction.Triggers>
<i:EventTrigger EventName="PreviewMouseLeftButtonDown">
<i:InvokeCommandAction
Command="{Binding RelativeSource={RelativeSource AncestorType={x:Type UserControl}}, Path=DataContext.JogDownCommand}"
EventArgsConverter="{StaticResource EventArgsConverter}"
EventArgsConverterParameter="{Binding}"
PassEventArgsToCommand="True" />
</i:EventTrigger>
</i:Interaction.Triggers>
关键点说明：
EventName: 指定要处理的事件。Command: 绑定到 ViewModel 中的命令。EventArgsConverter: 用于转换事件参数和命令参数。EventArgsConverterParameter: 传递当前的数据上下文。PassEventArgsToCommand: 设置为 True，以传递事件参数。
2. EventArgsConverter 实现
创建一个实现 IValueConverter 接口的转换器：
public class EventArgsConverter : IValueConverter
{
public object Convert(object value, Type targetType, object parameter, CultureInfo culture)
{
return new Tuple<object, RoutedEventArgs>(parameter, value as RoutedEventArgs);
}
public object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)
{
throw new NotImplementedException();
}
}
这个转换器将事件参数和数据上下文组合成一个 Tuple。
3. ViewModel 命令实现
在 ViewModel 中，定义接受 Tuple<object, RoutedEventArgs> 作为参数的命令：
public DelegateCommand<Tuple<object, RoutedEventArgs>> JogDownCommand =>
new DelegateCommand<Tuple<object, RoutedEventArgs>>(async tp =>
{
try
{
if (tp != null)
{
var jog = tp.Item1 as JogControl;
var eventArgs = tp.Item2;
var result = await _plc.SetAsync(jog.Address, true);
if (result) _logger.LogInformation($"Write {jog.Address} value to true success");
else _logger.LogError($"Write {jog.Address} value to true error");
}
}
catch { }
});
在这个实现中，我们可以同时访问数据上下文（tp.Item1）和事件参数（tp.Item2）。
4. 优势和注意事项
- 这种方法允许在保持 MVVM 模式的同时，访问both数据上下文和事件参数。
- 它提供了良好的分离性，视图逻辑保持在 XAML 中，而业务逻辑则在 ViewModel 中。
- 使用
EventArgsConverter提供了处理参数的灵活性。 - 注意要正确处理 null 值和类型转换，以增强代码的健壮性。
5. 替代方法：仅使用 RoutedEventArgs
除了使用 EventArgsConverter 同时传递数据上下文和事件参数外，还有一种更简单的方法，只传递 RoutedEventArgs，然后通过它来获取数据上下文。
XAML 配置
<i:Interaction.Triggers>
<i:EventTrigger EventName="PreviewMouseLeftButtonDown">
<i:InvokeCommandAction
Command="{Binding RelativeSource={RelativeSource AncestorType={x:Type UserControl}}, Path=DataContext.JogDownCommand}"
PassEventArgsToCommand="True" />
</i:EventTrigger>
</i:Interaction.Triggers>
ViewModel 命令实现
public DelegateCommand<RoutedEventArgs> JogDownCommand =>
new DelegateCommand<RoutedEventArgs>(async e =>
{
try
{
if (e.Source is FrameworkElement element)
{
var jog = element.DataContext as JogControl;
if (jog != null)
{
var result = await _plc.SetAsync(jog.Address, true);
if (result) _logger.LogInformation($"Write {jog.Address} value to true success");
else _logger.LogError($"Write {jog.Address} value to true error");
}
}
}
catch { }
});
在这种方法中，我们通过 RoutedEventArgs 的 Source 属性获取触发事件的控件，然后从该控件获取 DataContext。
6. 两种方法的比较
- 使用 EventArgsConverter 的方法：
- 优点：
- 直接提供数据上下文，无需额外的类型检查和转换。
- 可以同时传递多个参数，更灵活。
- 在复杂场景下更容易扩展。
- 缺点：
- 需要额外的转换器类。
- XAML 配置略微复杂。
- 优点：
- 仅使用 RoutedEventArgs 的方法：
- 优点：
- XAML 配置更简单。
- 不需要额外的转换器类。
- 对于简单场景，代码更少。
- 缺点：
- 需要在命令中进行类型检查和转换。
- 如果控件层次结构复杂，可能需要额外的逻辑来找到正确的 DataContext。
- 不太直观，可能需要对 WPF 事件路由有更深入的理解。
- 优点：
选择建议
- 对于简单的场景，尤其是当您只需要处理单一类型的控件时，仅使用 RoutedEventArgs 的方法可能更加简洁。
- 对于复杂的场景，特别是当您需要传递多个参数或者处理不同类型的控件时，使用 EventArgsConverter 的方法更加灵活和可扩展。
- 考虑项目的一致性和团队的熟悉程度。如果项目中已经广泛使用了某种方法，保持一致性可能更重要。
7. 高级用法：使用多个转换器
在某些复杂场景中，我们可能需要更精确地控制传递给命令的参数。这可以通过使用两个不同的转换器来实现：
<i:Interaction.Triggers>
<i:EventTrigger EventName="PreviewMouseLeftButtonDown">
<i:InvokeCommandAction
Command="{Binding RelativeSource={RelativeSource AncestorType={x:Type UserControl}}, Path=DataContext.JogDownCommand}"
PassEventArgsToCommand="True">
<i:InvokeCommandAction.EventArgsConverter>
<local:EventArgsConverter/>
</i:InvokeCommandAction.EventArgsConverter>
<i:InvokeCommandAction.EventArgsConverterParameter>
<MultiBinding Converter="{StaticResource ParameterMultiValueConverter}">
<Binding RelativeSource="{RelativeSource Self}"/>
<Binding Path=""/>
</MultiBinding>
</i:InvokeCommandAction.EventArgsConverterParameter>
</i:InvokeCommandAction>
</i:EventTrigger>
</i:Interaction.Triggers>
这里使用了两个不同的转换器：
EventArgsConverter: 实现IValueConverter接口，用于处理事件参数和EventArgsConverterParameter提供的值。
public class EventArgsConverter : IValueConverter
{
public object Convert(object value, Type targetType, object parameter, CultureInfo culture)
{
if (parameter is Tuple<object, object> tuple)
{
return new Tuple<object, object, RoutedEventArgs>(tuple.Item1, tuple.Item2, value as RoutedEventArgs);
}
return null;
}
public object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)
{
throw new NotImplementedException();
}
}
ParameterMultiValueConverter: 实现IMultiValueConverter接口，用于组合多个绑定值作为EventArgsConverterParameter。
public class ParameterMultiValueConverter : IMultiValueConverter
{
public object Convert(object[] values, Type targetType, object parameter, CultureInfo culture)
{
return new Tuple<object, object>(values[0], values[1]);
}
public object[] ConvertBack(object value, Type[] targetTypes, object parameter, CultureInfo culture)
{
throw new NotImplementedException();
}
}
工作流程如下：
ParameterMultiValueConverter首先组合控件自身和其DataContext。- 这个组合后的值作为参数传递给
EventArgsConverter。 EventArgsConverter将这个参数与事件参数（RoutedEventArgs）结合，创建最终传递给命令的参数。
ViewModel 中的命令可以这样定义：
public DelegateCommand<Tuple<object, object, RoutedEventArgs>> JogDownCommand =>
new DelegateCommand<Tuple<object, object, RoutedEventArgs>>((param) =>
{
var control = param.Item1 as FrameworkElement;
var dataContext = param.Item2 as JogControl;
var args = param.Item3;
if (control != null && dataContext != null)
{
// 处理 jog 操作
}
});
这种方法的优点是它允许我们精确控制传递给命令的参数，同时保持 XAML 的灵活性。我们可以轻松地获取控件、其 DataContext 和事件参数，这在处理复杂交互时非常有用。
通过使用多个转换器，我们可以更灵活地处理各种复杂的场景，为不同的需求提供定制化的解决方案。
