WPF 输入附加事件

我们都知道路由事件，而附加路由事件用的比较少。

但如果是通用的场景，类似附加属性，附加事件就很有必要的。

举个例子，输入设备有很多种，WPF中输入事件主要分为鼠标、触摸、触笔：WPF 屏幕点击的设备类型 - 唐宋元明清2188 - 博客园 (cnblogs.com)

有这么多输入事件Mouse、Touch、Stylus，另外按钮Click还处理了冒泡事件，事件类型就更多了。

但绝大部分业务其实并不关心事件类型，只需要一个触发事件就行了。

所以我们有这样的需求：设计并提供一个通用的输入事件，大家只需要拿到事件进行业务操作。另外一些小场景，如果需要具体事件如触摸点集，可以从事件源参数内部去获取。

具体的通用输入事件，我们另外讨论，这里主要描述如何自定义附加事件

附加事件定义

WPF官方对附加事件的描述 - 附加事件概述 - WPF .NET Framework | Microsoft Learn

所以我们先定义一个附加事件类：

    public class DeviceEvents
    {
        /// <summary>
        /// 按压事件
        /// </summary>
        public static readonly RoutedEvent PreviewDeviceDownEvent = EventManager.RegisterRoutedEvent("PreviewDeviceDown", RoutingStrategy.Bubble, typeof(RoutedEventHandler), typeof(DeviceEvents));
        public static void AddPreviewDeviceDownHandler(DependencyObject d, RoutedEventHandler handler)
        {
            (d as UIElement)?.AddHandler(DeviceEvents.PreviewDeviceDownEvent, handler);
        }
        public static void RemovePreviewDeviceDownHandler(DependencyObject d, RoutedEventHandler handler)
        {
            (d as UIElement)?.RemoveHandler(DeviceEvents.PreviewDeviceDownEvent, handler);
        }
    }

然后，我们看下如何封装原有事件PreviewMouseDown、PreviewStylusDown，并转换成此PreviewDeviceDown事件

在界面上添加下事件：

    <Button x:Name="TestButton"  
            Content="测试" Height="30" Width="120"
            local:DeviceEvents.PreviewDeviceDown="TestButton_OnPreviewDeviceDown"/>

我们会发现界面加载时，AddPreviewDeviceDownHandler不会触发调用。附加事件，与附加属性原理不一样，附加事件相当于在编译时注入委托（事件处理程序）AddPreviewDeviceDownHandler，界面加载时不会执行这个委托注册。

所以，我们可以通过另一个附加属性来开关附加事件，并且内部集成事件的触发。具体设计如下：

    public class DeviceEvents
    {
        private static readonly List<DeviceEventTransformer> EventTransformers = new List<DeviceEventTransformer>();

        /// <summary>
        /// 是否开启附加事件
        /// </summary>
        public static readonly DependencyProperty IsOpenProperty = DependencyProperty.RegisterAttached(
            "IsOpen", typeof(bool), typeof(DeviceEvents), new PropertyMetadata(default(bool), OnIsOpenPropertyChanged));
        private static void OnIsOpenPropertyChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
        {
            if (d is UIElement element && e.NewValue is bool isOpen)
            {
                var eventTransformer = EventTransformers.FirstOrDefault(i => i.Target == element);
                if (isOpen)
                {
                    if (eventTransformer == null)
                    {
                        eventTransformer = new DeviceEventTransformer(element);
                        EventTransformers.Add(eventTransformer);
                    }
                    eventTransformer.Register();
                }
                else
                {
                    eventTransformer?.UnRegister();
                }
            }
        }

        public static void SetIsOpen(DependencyObject element, bool value)
        {
            element.SetValue(IsOpenProperty, value);
        }
        public static bool GetIsOpen(DependencyObject element)
        {
            return (bool)element.GetValue(IsOpenProperty);
        }

        /// <summary>
        /// 按压事件
        /// </summary>
        public static readonly RoutedEvent PreviewDeviceDownEvent = EventManager.RegisterRoutedEvent("PreviewDeviceDown", RoutingStrategy.Bubble, typeof(RoutedEventHandler), typeof(DeviceEvents));
        public static void AddPreviewDeviceDownHandler(DependencyObject d, RoutedEventHandler handler)
        {
            (d as UIElement)?.AddHandler(DeviceEvents.PreviewDeviceDownEvent, handler);
        }
        public static void RemovePreviewDeviceDownHandler(DependencyObject d, RoutedEventHandler handler)
        {
            (d as UIElement)?.RemoveHandler(DeviceEvents.PreviewDeviceDownEvent, handler);
        }
    }
    /// <summary>
    /// 事件转换器
    /// </summary>
    public class DeviceEventTransformer
    {
        private readonly UIElement _uiElement;

        public DeviceEventTransformer(UIElement uiElement)
        {
            _uiElement = uiElement;
        }
        public UIElement Target => _uiElement;

        public void Register()
        {
            _uiElement.PreviewMouseDown += UiElement_PreviewMouseDown;
            _uiElement.PreviewStylusDown += UiElement_PreviewStylusDown;
        }

        public void UnRegister()
        {
            _uiElement.PreviewMouseDown -= UiElement_PreviewMouseDown;
            _uiElement.PreviewStylusDown -= UiElement_PreviewStylusDown;
        }

        private void UiElement_PreviewMouseDown(object sender, System.Windows.Input.MouseButtonEventArgs e)
        {
            OnPreviewDeviceDown(e);
        }
        private void UiElement_PreviewStylusDown(object sender, StylusDownEventArgs e)
        {
            OnPreviewDeviceDown(e);
        }

        private void OnPreviewDeviceDown(InputEventArgs e)
        {
            RoutedEventArgs reArgs = new RoutedEventArgs(DeviceEvents.PreviewDeviceDownEvent, e);
            _uiElement.RaiseEvent(reArgs);
        }
    }

DeviceEventTransformer是一个事件封装器，如果只是后台代码，也可以直接使用DeviceEventTransformer订阅相关事件。

上面事件实现是一个案例，这里的代码比较粗糙，没有对鼠标、触摸做互斥处理。另外其它的事件类型如冒泡、隧道、Down、Up等，后续可以将DeviceEvents封装完整。

如此，设备事件就包含了鼠标、触摸、触笔。触摸触笔需要以设备ID(即e.TouchDevice.Id)区分多指的操作，触摸需要额外添加触摸面积的获取，触笔需要将添加压感的获取。

附加事件使用

在界面上，我们可以直接在任意控件上添加此事件：

先添加DeviceEvents.IsOpen="True"开启设备附加事件，
然后订阅相应的附加事件DeviceEvents.PreviewDeviceDown="TestGrid_OnPreviewDeviceDown"

Demo：DeviceEventsDemo: WPF附加事件DEMO (gitee.com)

 

 关键字：鼠标、触摸、触笔、附加事件