WPF ContextMenu 的绑定和传参问题

原创已于 2025-07-30 19:09:36 修改 · 3.1k 阅读

10 ·

CC 4.0 BY-SA版权

文章标签：

#wpf #microsoft #c#

于 2022-05-07 16:47:20 首次发布

WPF 同时被 2 个专栏收录

8 篇文章

订阅专栏

7 篇文章

订阅专栏

本文探讨了在WPF中为ListView项目设置右键菜单时遇到的绑定和参数传递问题。当在ListView ItemTemplate中定义ContextMenu时，由于其逻辑树特性，无法直接绑定到上级控件的命令。微软推荐使用BindingProxy解决，但这种方法较为繁琐。另一种简化方法是在ListView级别定义ContextMenu，简化了绑定，但在传递命令参数时可能不便。

在ListView列表中，存在多个项目，每个项目都需要右键菜单进行操作。这时一般情况下定义的采用以下方式：即在模板中定义的控件内(在当前示例中是Border)，定义一个ContextMenu。Command在ViewModel中定义。

<Grid> 
 <Grid.Resources>
      <ViewModel:BindingProxy x:Key="BindingProxy" Data="{Binding}"/>
  </Grid.Resources>
<ListView ItemsSource="{Binding Records}">                
<ListView.ItemTemplate>
     <DataTemplate>

          <!--有右键菜单情况下，父级控件必须有背景色，否则在没有控件的地方右键无法弹出菜单。-->
        <Border Margin="2,0,2,0" Name="bd"  Background="Transparent">
              <Border.ContextMenu>
                 <ContextMenu>
                    <MenuItem Header="删除" Icon="🗑️"  Command="{Binding DeleteCmd}"   />
                  </ContextMenu>
        </Border.ContextMenu>
    </Border>
  </DataTemplate>
</ListView.ItemTemplate>
</ListView>
</Grid>

运行后会报找不到绑定的命令DeleteCmd。熟悉WPF绑定的话，会想过使用RelativeSource Mode=FindAncestor让它在上级控件的逻辑树中找。

遗憾的是 ContextMenu不存在于当前控件的逻辑树，它有自己的逻辑树，无法通过向上控件找到DataContext的命令。在找了许多资料后，微软给的方案是使用BindingProxy继承自Freezable。

    public class BindingProxy : Freezable
    {
        #region Overrides of Freezable

        protected override Freezable CreateInstanceCore()
        {
            return new BindingProxy();
        }

        #endregion

        public object Data
        {
            get { return (object)GetValue(DataProperty); }
            set { SetValue(DataProperty, value); }
        }

        public static readonly DependencyProperty DataProperty =
            DependencyProperty.Register("Data", typeof(object), typeof(BindingProxy),             new UIPropertyMetadata(null));
    }

在前台代码使用，同时使用CommandParameter传递当前选中项的数据到命令中：

     <ListView.ItemTemplate>
         <DataTemplate>
          <!--有右键菜单情况下，父级控件必须有背景色，否则在没有控件的地方右键无法弹出菜单。-->
          <Border Margin="2,0,2,0" Name="bd"  Background="Transparent"> 
             <Border.ContextMenu >
                  
              <!--微软对PlacementTarget的解释是：获取或设置UIElement，当它打开时相对于它确定ContextMenu的位置。应该可以理解为放置此ContextMenu的UIElement。-->
                   <ContextMenu Style="{StaticResource ContextMenuStyle}" DataContext="{Binding Data,Source={StaticResource BindingProxy}}"  >
                    <MenuItem Header="删除" Icon="🗑️" Style="{StaticResource MenuItemStyle}" Command="{Binding DeleteCmd}" 
                 CommandParameter="{Binding RelativeSource={RelativeSource Mode=FindAncestor, AncestorType=ContextMenu}, Path=PlacementTarget.DataContext}" />
                   </ContextMenu>

           </Border.ContextMenu>
   
  <TextBlock Text="示例"/> 
    </Border>

  </DataTemplate>
</ListView.ItemTemplate>

不足之处

使用这种方式虽然每个子项都可以绑定到父级控件中的命令，但是过于繁琐。一直在想办法替换掉这种麻烦的方法。

另外一种简单的方式(不绑定参数的情况下)：

直接在ListView中定义一个ContextMenu而不在ListView子项的ItemTemplate中创建。使用这种方式会简单很多。

代码如下：

<ListView ItemsSource="{Binding Records}">                

   <ListView.ItemTemplate>
          <DataTemplate>
              <Border Margin="2,0,2,0" Name="bd"  Background="Transparent">
                <Grid>
                  <TextBlock Text="示例"/>
                </Grid>
          </DataTemplate>
</ListView.ItemTemplate>

<!--上下文菜单  -->
<ListView.ContextMenu >
    <ContextMenu  >
     <MenuItem Header="删除" Icon="🗑️" Style="{StaticResource MenuItemStyle}"   Command="{Binding DeleteCmd}"/>
     </ContextMenu>
  </ListView.ContextMenu>
</ListView>

使用这种方式，不需要在DataTemplate都创建ContextMenu，没有BindingProxy 。但是对于MenuItem命令需要绑定参数的话不是很友好，如果仍需要绑定，建议还是使用第一种方式。