如何编写 WPF 的标记扩展 MarkupExtension,即便在 ControlTemplate/DataTemplate 中也能生效

如何编写 WPF 的标记扩展 MarkupExtension,即便在 ControlTemplate/DataTemplate 中也能生效

发布于 2018-05-29 12:56 更新于 2018-05-30 01:34

WPF 的标记扩展为 WPF 带来了强大的扩展性。利用自定义的标记扩展,我们能够为 XAML 中的属性提供各种各样种类的值,而不仅限于自带的那一些。

不过有小伙伴发现在 ControlTemplateDataTemplate 中编写标记扩展有时并不能正常工作,而本文将提供解决方法。


本文并不会详细讲解如何编写 WPF 的标记扩展,如果你想了解相关的知识,建议阅读官网:Markup Extensions and WPF XAML - Microsoft Docs

编写简单的标记扩展

一个简单的标记扩展会是像这样:

using System.Windows;
using System.Windows.Markup;
using System.Windows.Media;

namespace Walterlv.Demo
{
    public class RevealBorderBrushExtension : MarkupExtension
    {
        public override object ProvideValue(IServiceProvider serviceProvider)
        {
            return Brushes.White;
        }
    }
}

这样的标记扩展如此简单,以至于你可以在任意的 XAML 中用。只要赋值的那个属性接受 Brush 类型,就不会出错。

然而……有小伙伴写了更加复杂的标记扩展,在标记扩展中还通过 serviceProvider 拿到了目标控件的一些属性。本来一直好好工作的,结果有一天这个标记扩展被用到了 ControlTemplate 上,然后就挂了……挂了……

编写能在 ControlTemplate 中使用的标记扩展

ControlTemplate 中,XAML 标记扩展也是立即执行的,这就意味着当标记扩展中的 ProvideValue 执行时,还没有根据模板创建控件呢,那创建的是什么呢?

是一个名为 System.Windows.SharedDp 的对象,不明白是什么?没关系,微软把这个类设置为 internal 了,就是不想让你明白。所以,如果我们的标记扩展需要用到实际控件的一些功能(例如需要订阅事件、需要绑定、需要获取布局……),那么你就需要对 System.Windows.SharedDp 进行判断了。

具体来说,是加上这样的判断:

if (service.TargetObject.GetType().Name.EndsWith("SharedDp"))
{
    return this;
}

更完整一点写出来,就是这样:

using System;
using System.ComponentModel;
using System.Windows;
using System.Windows.Input;
using System.Windows.Markup;
using System.Windows.Media;

namespace Walterlv.Demo
{
    public class RevealBorderBrushExtension : MarkupExtension
    {
        public override object ProvideValue(IServiceProvider serviceProvider)
        {
            // 如果没有服务,则直接返回。
            if (!(serviceProvider.GetService(typeof(IProvideValueTarget)) is IProvideValueTarget service)) return null;
            // MarkupExtension 在样式模板中,返回 this 以延迟提供值。
            if (service.TargetObject.GetType().Name.EndsWith("SharedDp")) return this;
            // 如果不是 FrameworkElement,那么返回 this 以延迟提供值。
            if (!(service.TargetObject is FrameworkElement element)) return this;
            // 如果是设计时,那么返回白色
            if (DesignerProperties.GetIsInDesignMode(element)) return Brushes.White;

            var window = Window.GetWindow(element);
            if (window == null) return this;
            // 这一句是编译不通过的,我只是拿来做示范。
            var brush = CreateBrush(window, element);
            return brush;
        }
    }
}

你可能会觉得这段代码有些熟悉,如果有这种感觉,说明你可能阅读过我的另一篇博客:流畅设计 Fluent Design System 中的光照效果 RevealBrush,WPF 也能模拟实现啦!

本文会经常更新,请阅读原文: https://walterlv.com/post/wpf-markup-extension-in-control-template.html ,以避免陈旧错误知识的误导,同时有更好的阅读体验。

本作品采用 知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议 进行许可。欢迎转载、使用、重新发布,但务必保留文章署名 吕毅 (包含链接: https://walterlv.com ),不得用于商业目的,基于本文修改后的作品务必以相同的许可发布。如有任何疑问,请 与我联系 (walter.lv@qq.com)

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏.net

干货,比较全面的c#.net公共帮助类(Common.Utility)

       网上有各式各样的帮助类,公共类,但是比较零碎,经常有人再群里或者各种社交账号上问我有没有这个helper, 那个helper,于是萌生了收集全部h...

56180
来自专栏施炯的IoT开发专栏

EVC3/4项目升级到Visual Studio项目的一些建议

    大家都在忙着研究WP7了,每天在园子里有好多精彩的文章出现。这几天受朋友的委托,帮忙把他手头的一个项目进行升级。情况大概是这样的:项目是用EVC 3来开...

203100
来自专栏码云1024

托管C++、C++/CLI、CLR

36840
来自专栏walterlv - 吕毅的博客

阻止某个 NuGet 包意外升级

2018-06-29 09:59

15820
来自专栏jessetalks

异步编程 In .NET

概述   在之前写的一篇关于async和await的前世今生的文章之后,大家似乎在async和await提高网站处理能力方面还有一些疑问,博客园本身也做了不少的...

37170
来自专栏walterlv - 吕毅的博客

WPF 同一窗口内的多线程 UI(VisualTarget)

发布于 2017-10-30 15:38 更新于 2018-09...

41220
来自专栏iOS技术

打造开源第一 iOS 图片浏览器 (支持视频)闲谈

本文主要讲述 YBImageBrowser 的一些功能技术细节,代码架构思路,设计模式选择等,希望对组件原理感兴趣的朋友有所帮助,也可以作为如何高效构建图片浏览...

20840
来自专栏Fundebug

抛弃console.log(),拥抱浏览器Debugger

为了保证可读性,本文采用意译而非直译。另外,本文版权归原作者所有,翻译仅用于学习。

15430
来自专栏Golang语言社区

如何优雅地关闭Go channel

本文译自:How To Close Channels in Golang Elegantly。 几天前,我写了一篇文章来说明golang中channel的使用规...

27220
来自专栏跟着阿笨一起玩NET

基于ASP.NET WebAPI OWIN实现Self-Host项目实战

11520

扫码关注云+社区

领取腾讯云代金券