WPF 路由事件 Event Routing

原文:WPF 路由事件 Event Routing

1.路由事件介绍

之前介绍了WPF的新的依赖属性系统，本篇将介绍更高级的路由事件，替换了之前的.net普通事件。相比.net的事件，路由事件具有更强的传播能力，支持向上冒泡和向下隧道传播。路由事件允许源自某个元素的事件由另一个元素引发。

2.路由事件定义

WPF事件模型和WPF属性模型非常类似。都是只读的静态字段。

    [DefaultEvent("Click")]
    [Localizability(LocalizationCategory.Button)]
    public abstract class ButtonBase : ContentControl, ICommandSource
    {
        public static readonly RoutedEvent ClickEvent;
    }

3.路由事件注册

和WPF事件模型的注册与属性几乎一样，使用EventManager.RegisterRoutedEvent()来进行注册。可以查看该函数的说明：

        //
        // 摘要:
        //     向 Windows Presentation Foundation (WPF) 事件系统注册新的路由事件。
        //
        // 参数:
        //   name:
        //     路由事件的名称。该名称在所有者类型中必须是唯一的，并且不能为 null 或空字符串。
        //
        //   routingStrategy:
        //     作为枚举值的事件的路由策略。
        //
        //   handlerType:
        //     事件处理程序的类型。该类型必须为委托类型，并且不能为 null。
        //
        //   ownerType:
        //     路由事件的所有者类类型。该类型不能为 null。
        //
        // 返回结果:
        //     新注册的路由事件的标识符。现在可将该标识符对象存储为类中的静态字段，然后将其用作将处理程序附加到事件的方法的参数。路由事件标识符也用于其他事件系统
        //     APIs。
        public static RoutedEvent RegisterRoutedEvent(string name, RoutingStrategy routingStrategy, Type handlerType, Type ownerType);

与依赖属性同样，在一个静态构造函数中注册：

        static ButtonBase()
        {
            ButtonBase.ClickEvent=EventManager.RegisterRoutedEvent
                ("Click",RoutingStrategy.Bubble,typeof(RoutedEventHandler),typeof(ButtonBase));
        }

4.路由事件包装

路由事件通过普通的.net事件进行包装。从而使所有.net语言都能访问它们。事件包装器可以使用AddHandler()和RemoveHandler()方法添加和删除已注册的调用程序。

AddHandler与RemoveHandler在基类UIElement中定义，每个WPF元素都继承它们。

        // 摘要:
        //     在单击 System.Windows.Controls.Button 时发生。
        [Category("Behavior")]
        public event RoutedEventHandler Click
        {
            add
            {
                base.AddHandler(ButtonBase.ClickEvent, value);
            }
            remove
            {
                base.RemoveHandler(ButtonBase.ClickEvent, value);
            }
        }

5.路由事件共享

public RoutedEvent AddOwner(Type ownerType);

将路由事件关联另一个所有者类型，并启用事件及其处理的路由

WPF中所有控件的基类UIElement类型就共享了MouseUp事件。MouseUp事件是在System.Windows.Input.Mouse类定义的。UIElement只是通过了AddOwner()方法重用了MouseUp事件。

UIElement.MouseUpEvent=Mouse.MouseUpEvent.AddOwner(typeof(UIElement));

6.引发路由事件

            RoutedEventArgs args = new RoutedEventArgs(ButtonBase.ClickEvent,this);
            base.RaiseEvent(args);

RaiseEvent方法负责为每个已经通过AddHandler()方法注册的调用程序引发路由事件。 

这里先贴出来RoutedEventArgs的构造函数。

        // 参数:
        //   routedEvent:
        //     System.Windows.RoutedEventArgs 类的此实例的路由事件标识符。
        //
        //   source:
        //     将在处理事件时报告的备用源。这将预先填充 System.Windows.RoutedEventArgs.Source 属性。
        public RoutedEventArgs(RoutedEvent routedEvent, object source);

RoutedEventArgs有下面四个属性：

1.Source  指定了引发事件的对象 

2.OriginalSource 指出了最初是什么对象引发了事件。比Source更深一层。

3.Handled 用户来终止事件的冒泡或者隧道过程。如果一个控件将Handled设置为true，刚这个事件就不会继续传递下去。

4.RoutedEvent 获取或设置与此RoutedEventArgs 实例关联的路由事件。

通过使用RoutedEventArgs我们可以为事件提供相应的源。在WPF中，如果一个事件确实需要传递额外的信息，我们可以自定义一个对象，继承自RoutedEventArgs。例如WPF中常见的MouseEventArgs。

7.关联路由事件

将后台事件处理程序与前台元素相关联有很多种方法。最常见的就是为Xaml添加事件特性。如：

<Button x:Name="button1" Content="ok" Width="80" Height="40" Click="button1_Click"/>

或者不需要元素名，如：

<Button Content="ok" Width="80" Height="40" Click="OK_Click"/>

也可以在后台代码中进行连接事件，如：

img.MouseUp+=new MouseButtonEventHandler(img_MouseUp);

C#还支持隐式地创建委托对象：

img.MouseUp+=img_MouseUp;

上述方法实质上都是调用了事件包装器（小节4）。我们可以直接调用UIElement.AddHandler()方法来直接连接事件。如：

img.AddHandler(Image.MouseUpEvent,new MouseButtonEventHandler(img_MouseUp));

8.断开关联

断开与路由事件的关联主要有两种方法：

1.-=运算符：

img.MouseUp-=img_MouseUp;

2.使用UIElement.RemoveHandler()方法：

img.RemoveHandler(Image.MouseUpEvent,new MouseButtonEventHandler(img_MouseUp));

9.最后的例子

与之前一样，以一个小例子结尾，来帮助理解。代码不多，直接贴上来

 public partial class MainWindow : Window
    {
        public MainWindow()
        {
            InitializeComponent();
            this.AddHandler(BigDog.TestEvent, new RoutedEventHandler(this.TestHandler));
        }
        private void TestHandler(object sender, RoutedEventArgs e)
        {
            MessageBox.Show((e.OriginalSource as BigDog).Name.ToString());
            e.Handled = true;
        }

        private void button1_Click(object sender, RoutedEventArgs e)
        {
            BigDog dear = new BigDog { Name="Dear"};
            RoutedEventArgs args = new RoutedEventArgs(BigDog.TestEvent, dear);
            //引发路由事件
            this.button1.RaiseEvent(args);
        }
    }
    public class BigDog
    {
        public string Name { get; set; }
        //定义路由事件
        public static readonly RoutedEvent TestEvent = EventManager.RegisterRoutedEvent
            ("Test", RoutingStrategy.Bubble, typeof(RoutedEventHandler), typeof(BigDog));
    }