内容简介:在 Binding 中使用 ElementName 司空见惯,没见它出过什么事儿。不过当你预见 ContextMenu,或者类似 Grid.Row / Grid.Column 这样的属性中设置的时候,ElementName 就不那么管用了。本文将解决这个问题。
在 Binding 中使用 ElementName 司空见惯,没见它出过什么事儿。不过当你预见 ContextMenu,或者类似 Grid.Row / Grid.Column 这样的属性中设置的时候,ElementName 就不那么管用了。
本文将解决这个问题。
以下代码是可以正常工作的
<Window x:Class="Walterlv.Demo.BindingContext.MainWindow" xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" x:Name="WalterlvWindow" Title="Walterlv Binding Demo" Height="450" Width="800"> <Grid Background="LightGray" Margin="1 1 1 0" MinHeight="40"> <TextBlock> <Run Text="{Binding Mode=OneWay}" FontSize="20" /> <LineBreak /> <Run Text="{Binding ElementName=WalterlvWindow, Path=DemoText, Mode=OneWay}" /> </TextBlock> </Grid> </Window>
在代码中,我们为一段文字中的一个部分绑定了主窗口的的一个属性,于是我们使用 ElementName
来指定绑定源为 WalterlvWindow
。
▲ 使用普通的 ElementName 绑定
以下代码就无法正常工作了
保持以上代码不变,我们现在新增一个 ContextMenu
,然后在 ContextMenu
中使用一模一样的绑定表达式:
<Window x:Class="Walterlv.Demo.BindingContext.MainWindow" xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" x:Name="WalterlvWindow" Title="Walterlv Binding Demo" Height="450" Width="800"> <Grid Background="LightGray" Margin="1 1 1 0" MinHeight="40"> <Grid.ContextMenu> <ContextMenu> <MenuItem Header="{Binding ElementName=WalterlvWindow, Path=DemoText, Mode=OneWay}" /> </ContextMenu> </Grid.ContextMenu> <TextBlock> <Run Text="{Binding Mode=OneWay}" FontSize="20" /> <LineBreak /> <Run Text="{Binding ElementName=WalterlvWindow, Path=DemoText, Mode=OneWay}" /> </TextBlock> </Grid> </Window>
注意, MenuItem
的 Header
属性设置为和 Run
的 Text
属性一模一样的绑定字符串。不过运行之后的截图显示,右键菜单中并没有如预期般出现绑定的字符串。
使用 x:Reference 代替 ElementName 能够解决
以上绑定失败的原因,是 Grid.ContextMenu
属性中赋值的 ContextMenu
不在可视化树中,而 ContextMenu
又不是一个默认建立 ScopeName 的控件,此时既没有自己指定 NameScope,有没有通过可视化树寻找上层设置的 NameScope,所以在绑定上下文中是找不到 WalterlvWindow
的。如果调用去查找,得到的是 null
。详见:WPF 中的 NameScope。
类似的情况也发生在设置非可视化树或逻辑树的属性时,典型的比如在 Grid.Row
或 Grid.Column
属性上绑定时, ElementName
也是失效的。
此时最适合的情况是直接使用 x:Reference
。
<Window x:Class="Walterlv.Demo.BindingContext.MainWindow" xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" x:Name="WalterlvWindow" Title="Walterlv Binding Demo" Height="450" Width="800"> <Grid Background="LightGray" Margin="1 1 1 0" MinHeight="40"> <Grid.ContextMenu> <ContextMenu> - <MenuItem Header="{Binding ElementName=WalterlvWindow, Path=DemoText, Mode=OneWay}" /> + <MenuItem Header="{Binding Source={x:Reference WalterlvWindow}, Path=DemoText, Mode=OneWay}" /> </ContextMenu> </Grid.ContextMenu> <TextBlock> <Run Text="{Binding Mode=OneWay}" FontSize="20" /> <LineBreak /> <Run Text="{Binding ElementName=WalterlvWindow, Path=DemoText, Mode=OneWay}" /> </TextBlock> </Grid> </Window>
不过,这是个假象,因为此代码运行时会抛出异常:
XamlObjectWriterException: Cannot call MarkupExtension.ProvideValue because of a cyclical dependency. Properties inside a MarkupExtension cannot reference objects that reference the result of the MarkupExtension. The affected MarkupExtensions are: ‘System.Windows.Data.Binding’ Line number ‘8’ and line position ‘27’.
因为给 MenuItem
的 Header
属性绑定赋值的时候,创建绑定表达式用到了 WalterlvWindow
,但此时 WalterlvWindow
尚在构建(因为里面的 ContextMenu
是窗口的一部分),于是出现了循环依赖。而这是不允许的。
为了解决循环依赖问题,我们可以考虑将 x:Reference
放到资源中。因为资源是按需创建的,所以这不会造成循环依赖。
那么总得有一个对象来承载我们的绑定源。拿控件的 Tag
属性也许是一个方案,不过专门为此建立一个绑定代理类也许是一个更符合语义的方法:
<Window x:Class="Walterlv.Demo.BindingContext.MainWindow" xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" + xmlns:local="clr-namespace:Walterlv.Demo.BindingContext" x:Name="WalterlvWindow" Title="Walterlv Binding Demo" Height="450" Width="800"> + <Window.Resources> + <local:BindingProxy x:Key="WalterlvBindingProxy" Data="{x:Reference WalterlvWindow}" /> + </Window.Resources> <Grid Background="LightGray" Margin="1 1 1 0" MinHeight="40"> <Grid.ContextMenu> <ContextMenu> - <MenuItem Header="{Binding Source={x:Reference WalterlvWindow}, Path=DemoText, Mode=OneWay}" /> + <MenuItem Header="{Binding Source={StaticResource WalterlvBindingProxy}, Path=Data.DemoText, Mode=OneWay}" /> </ContextMenu> </Grid.ContextMenu> <TextBlock> <Run Text="{Binding Mode=OneWay}" FontSize="20" /> <LineBreak /> <Run Text="{Binding ElementName=WalterlvWindow, Path=DemoText, Mode=OneWay}" /> </TextBlock> </Grid> </Window>
至于 BindingProxy
,非常简单:
public sealed class BindingProxy : Freezable { public static readonly DependencyProperty DataProperty = DependencyProperty.Register( "Data", typeof(object), typeof(BindingProxy), new PropertyMetadata(default(object))); public object Data { get => (object) GetValue(DataProperty); set => SetValue(DataProperty, value); } protected override Freezable CreateInstanceCore() => new BindingProxy(); public override string ToString() => Data is FrameworkElement fe ? $"BindingProxy: {fe.Name}" : $"Binding Proxy: {Data?.GetType().FullName}"; }
现在运行,右键菜单已经正常完成了绑定。
▲ 右键菜单已经正常完成了绑定
参考资料
本文会经常更新,请阅读原文: https://walterlv.com/post/fix-wpf-binding-issues-in-context-menu.html ,以避免陈旧错误知识的误导,同时有更好的阅读体验。
本作品采用 知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议 进行许可。欢迎转载、使用、重新发布,但务必保留文章署名 吕毅 (包含链接:https://walterlv.com ),不得用于商业目的,基于本文修改后的作品务必以相同的许可发布。如有任何疑问,请 与我联系 (walter.lv@qq.com) 。
以上就是本文的全部内容,希望本文的内容对大家的学习或者工作能带来一定的帮助,也希望大家多多支持 码农网
猜你喜欢:- ClickHouse 性能优化?试试物化视图
- 试试 kaggle 竞赛:辨别猫狗
- 创建复杂对象,试试建造者模式
- SpringMVC配置太多?试试SpringBoot
- 记一次前端面试试水笔记
- Git 入门太难?试试这个教程吧
本站部分资源来源于网络,本站转载出于传递更多信息之目的,版权归原作者或者来源机构所有,如转载稿涉及版权问题,请联系我们。