为什么 TextBlock 不是路由事件上的 OriginalSource？

Question

我正在显示 ListView 中元素的上下文菜单。上下文菜单附加到 ListView 的 TextBlock，如下所示。

<ListView.Resources>
 <ContextMenu x:Key="ItemContextMenu">
  <MenuItem Command="local:MyCommands.Test" />
 </ContextMenu>
 <Style TargetType="{x:Type TextBlock}" >
  <Setter Property="ContextMenu" Value="{StaticResource ItemContextMenu}" />
 </Style>
</ListView.Resources>

上下文菜单正确显示并且 RoutedUIEvent 也被触发。问题是在执行的回调中 ExecutedRoutedEventArgs.OriginalSource 是一个 ListViewItem 而不是 TextBlock。

我尝试设置 IsHitTestVisible 属性以及 Background （见下文），因为 MSDN 说 OriginalSource is determined by hit testing

请注意，我使用 GridView 作为 ListView 中的视图。这就是我想要访问 TextBlock（获取列索引）的原因

主窗口

<Window x:Class="WpfApp1.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
        xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
        xmlns:local="clr-namespace:WpfApp1"
        xmlns:sys="clr-namespace:System;assembly=mscorlib"
        mc:Ignorable="d"
        Title="MainWindow" Height="350" Width="525">
    <ListView>
        <ListView.Resources>
            <x:Array Type="{x:Type local:Data}" x:Key="Items">
                <local:Data Member1="First Item" />
                <local:Data Member1="Second Item" />
            </x:Array>
            <ContextMenu x:Key="ItemContextMenu">
                <MenuItem Header="Test" Command="local:MainWindow.Test" />
            </ContextMenu>
            <Style TargetType="{x:Type TextBlock}" >
                <Setter Property="ContextMenu" Value="{StaticResource ItemContextMenu}" />
                <Setter Property="IsHitTestVisible" Value="True" />
                <Setter Property="Background" Value="Wheat" />
            </Style>
        </ListView.Resources>
        <ListView.ItemsSource>
            <StaticResource ResourceKey="Items" />
        </ListView.ItemsSource>
        <ListView.View>
            <GridView>
                <GridView.Columns>
                    <GridViewColumn Header="Member1" DisplayMemberBinding="{Binding Member1}"/>
                </GridView.Columns>
            </GridView>
        </ListView.View>
    </ListView>
</Window>

MainWindow.xaml.cs

using System.Diagnostics;
using System.Windows;
using System.Windows.Input;

namespace WpfApp1
{
    public class Data
    {
        public string Member1 { get; set; }
    }

    public partial class MainWindow : Window
    {
        public static RoutedCommand Test = new RoutedCommand();

        public MainWindow()
        {
            InitializeComponent();
            CommandBindings.Add(new CommandBinding(Test, (s, e) =>
            {
                Debugger.Break();
            }));
        }
    }
}

Answer 1

关于您的问题，或者更确切地说……关于 WPF 的一个令人沮丧的事情，因为它与您问题中提出的场景相关，是 WPF 似乎针对这个特定场景设计不佳。特别是：

DisplayMemberBinding 和 CellTemplate 属性不能一起工作。 IE。您可以指定其中之一，但不能同时指定两者。如果您指定 DisplayMemberBinding，它会优先并且不提供显示格式的自定义，除了在隐式使用的 TextBlock 的样式中应用 setter。
DisplayMemberBinding 不参与 WPF 其他地方常见的隐式数据模板行为。也就是说，当您使用此属性时，控件显式使用 TextBlock 来显示数据，将值绑定到 TextBlock.Text 属性。所以你最好绑定到 string 值；如果您尝试使用不同的类型，WPF 不会为您查找任何其他数据模板。

然而，即使有这些挫败感，我还是找到了两条不同的途径来解决您的问题。一条路径直接关注您的确切请求，而另一条路径后退一步，（我希望）解决您试图解决的更广泛的问题。

第二条路径产生的代码比第一条更简单，恕我直言，因为这个原因更好，因为它不涉及摆弄可视化树和该树的各种元素相对位置的实现细节彼此。因此，我将首先展示（即，在复杂的意义上，这实际上是 "first" 路径，而不是 "second" :)）。

首先，你需要一个小帮手class:

class GridColumnDisplayData
{
    public object DisplayValue { get; set; }
    public string ColumnProperty { get; set; }
}

然后您将需要一个转换器来为您的网格单元生成 class 的实例：

class GridColumnDisplayDataConverter : IValueConverter
{
    public object Convert(object value, Type targetType, object parameter, CultureInfo culture)
    {
        return new GridColumnDisplayData { DisplayValue = value, ColumnProperty = (string)parameter };
    }

    public object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)
    {
        throw new NotImplementedException();
    }
}

XAML 看起来像这样：

<Window x:Class="TestSO44549611TextBlockMenu.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
        xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
        xmlns:l="clr-namespace:TestSO44549611TextBlockMenu"
        xmlns:s="clr-namespace:System;assembly=mscorlib"
        mc:Ignorable="d"
        Title="MainWindow" Height="350" Width="525">
  <ListView>
    <ListView.Resources>
      <x:Array Type="{x:Type l:Data}" x:Key="Items">
        <l:Data Member1="First Item"/>
        <l:Data Member1="Second Item"/>
      </x:Array>
      <ContextMenu x:Key="ItemContextMenu">
        <MenuItem Header="Test" Command="l:MainWindow.Test"
                  CommandParameter="{Binding ColumnProperty}"/>
      </ContextMenu>
      <DataTemplate DataType="{x:Type l:GridColumnDisplayData}">
        <TextBlock Background="Wheat" Text="{Binding DisplayValue}"
                   ContextMenu="{StaticResource ItemContextMenu}"/>
      </DataTemplate>
      <l:GridColumnDisplayDataConverter x:Key="columnDisplayConverter"/>
    </ListView.Resources>
    <ListView.ItemsSource>
      <StaticResource ResourceKey="Items" />
    </ListView.ItemsSource>
    <ListView.View>
      <GridView>
        <GridView.Columns>
          <GridViewColumn Header="Member1">
            <GridViewColumn.CellTemplate>
              <DataTemplate>
                <ContentPresenter Content="{Binding Member1,
                            Converter={StaticResource columnDisplayConverter}, ConverterParameter=Member1}"/>
              </DataTemplate>
            </GridViewColumn.CellTemplate>
          </GridViewColumn>
        </GridView.Columns>
      </GridView>
    </ListView.View>
  </ListView>
</Window>

这样做是将 Data 对象映射到它们各自的属性值，以及这些属性值的名称。这样，当应用数据模板时，MenuItem 可以将 CommandParameter 绑定到那个属性值名称，因此它可以在处理程序中访问。

请注意，这不是使用 DisplayMemberBinding，而是使用 CellTemplate，并将显示成员绑定移动到模板中 ContentPresenter 的 Content。由于上述烦恼，这是必需的；没有这个，就无法将用户定义的数据模板应用于用户定义的 GridColumnDisplayData 对象，以正确显示其 DisplayValue 属性.

这里有点冗余，因为您必须绑定到属性路径，并将属性名称指定为转换器参数。不幸的是，后者容易出现印刷错误，因为在编译时或运行时没有任何东西会发现不匹配。我想在调试版本中，您可以添加一些反射以通过转换器参数中给定的属性名称检索属性值，并确保它与绑定路径中给定的相同。

在您的问题和评论中，您表达了返回树上以更直接地找到属性名称的愿望。 IE。在命令参数中，传递 TextBlock 对象引用，然后使用它导航回到绑定的属性名称。从某种意义上说，这更可靠，因为它直接转到属性名称绑定。另一方面，在我看来，依赖于可视化树的确切结构和在其中找到的绑定更加脆弱。在长期运行，似乎可能会产生更高的维护成本。

也就是说，我确实想出了一个方法来实现这个目标。首先，与另一个示例一样，您需要一个助手 class 来存储数据：

public class GridCellHelper
{
    public object DisplayValue { get; set; }
    public UIElement UIElement { get; set; }
}

同样，转换器（这次是 IMultiValueConverter）为每个单元格创建 class 的实例：

class GridCellHelperConverter : IMultiValueConverter
{
    public object Convert(object[] values, Type targetType, object parameter, CultureInfo culture)
    {
        return new GridCellHelper { DisplayValue = values[0], UIElement = (UIElement)values[1] };
    }

    public object[] ConvertBack(object value, Type[] targetTypes, object parameter, CultureInfo culture)
    {
        throw new NotImplementedException();
    }
}

最后，XAML:

<Window x:Class="TestSO44549611TextBlockMenu.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
        xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
        xmlns:l="clr-namespace:TestSO44549611TextBlockMenu"
        xmlns:s="clr-namespace:System;assembly=mscorlib"
        mc:Ignorable="d"
        Title="MainWindow" Height="350" Width="525">
  <ListView>
    <ListView.Resources>
      <x:Array Type="{x:Type l:Data}" x:Key="Items">
        <l:Data Member1="First Item"/>
        <l:Data Member1="Second Item"/>
      </x:Array>
      <l:GridCellHelperConverter x:Key="cellHelperConverter"/>
    </ListView.Resources>
    <ListView.ItemsSource>
      <StaticResource ResourceKey="Items" />
    </ListView.ItemsSource>
    <ListView.View>
      <GridView>
        <GridView.Columns>
          <GridViewColumn Header="Member1">
            <GridViewColumn.CellTemplate>
              <DataTemplate>
                <TextBlock Background="Wheat" Text="{Binding DisplayValue}">
                  <TextBlock.DataContext>
                    <MultiBinding Converter="{StaticResource cellHelperConverter}">
                      <Binding Path="Member1"/>
                      <Binding RelativeSource="{x:Static RelativeSource.Self}"/>
                    </MultiBinding>
                  </TextBlock.DataContext>
                  <TextBlock.ContextMenu>
                    <ContextMenu>
                      <MenuItem Header="Test" Command="l:MainWindow.Test"
                        CommandParameter="{Binding UIElement}"/>
                    </ContextMenu>
                  </TextBlock.ContextMenu>
                </TextBlock>
              </DataTemplate>
            </GridViewColumn.CellTemplate>
          </GridViewColumn>
        </GridView.Columns>
      </GridView>
    </ListView.View>
  </ListView>
</Window>

在此版本中，您可以看到单元格模板用于设置包含绑定属性值和对 TextBlock 的引用的 DataContext 值。这些值然后由模板中的各个元素解包，即 TextBlock.Text 属性和 MenuItem.CommandParameter 属性.

这里明显的缺点是，因为显示成员必须绑定 inside 正在声明的单元格模板，所以必须为每一列重复代码。我没有看到重用模板的方法，以某种方式将属性名称传递给它。（另一个版本也有类似的问题，不过实现起来简单多了，所以copy/paste就显得不那么繁琐了）。

但它确实可靠地将 TextBlock 引用发送到您的命令处理程序，这正是您所要求的。所以，就是这样。 :)

为什么 TextBlock 不是路由事件上的 OriginalSource？

Why is the TextBlock not the OriginalSource on the Routed Event?

c#

wpf

xaml

routed-events

routedeventargs

主窗口

MainWindow.xaml.cs