WPF 学习笔记 - 6. RoutedEvent

WPF 的采取了路由事件机制，这样事件可以在可视树上层级传递。要知道 XAML 中控件都是由很多其他元素组合而成，比如我们单击了 Button 内部的 TextBlock 元素，Button 依然可以可以接收到该事件并触发 Button.Click。通常情况下，我们只是关心逻辑树上的事件过程。

我们看看 Button Click 事件的实现。

public abstract class ButtonBase : ContentControl, ICommandSource
{
  public static readonly RoutedEvent ClickEvent;

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

  public event RoutedEventHandler Click
  {
    add { base.AddHandler(ClickEvent, value); }
    remove { base.RemoveHandler(ClickEvent, value); }
  }
}

看上去很简单，不是吗？和依赖属性有点类似。

注册路由事件时，我们可以选择不同的路由策略。

• 管道传递(Tunneling): 事件首先在根元素上触发，然后向下层级传递，直到那个最初触发事件的子元素。
• 冒泡(Bubbling): 事件从最初触发事件的子元素向根元素层级往上传递。
• 直接(Direct): 事件仅在最初触发事件的子元素上触发。

Window1.xaml

<Window x:Class="Learn.WPF.Window1"
  xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
  xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
  Title="Window1">
  <Grid>
    <Border MouseRightButtonDown="MouseRightButtonDown">
      <StackPanel MouseRightButtonDown="MouseRightButtonDown">
        <Button MouseRightButtonDown="MouseRightButtonDown">Test</Button>
      </StackPanel>
    </Border>
  </Grid>
</Window>

Window1.xaml.cs

public partial class Window1 : Window
{
  public Window1()
  {
    InitializeComponent();
  }

  private void MouseRightButtonDown(object sender, MouseButtonEventArgs e)
  {
    MessageBox.Show((sender as Label).Name);
  }
}

在按钮上单击右键后，你会依次看到显示 "Button"、"StackPanel"、"Border" 的三个对话框，显然事件按照冒泡向根元素传递。

有一点需要注意，WPF 路由事件参数有个 Handled 属性标记，一旦被某个程序标记为已处理，事件传递就会终止。测试一下。

public partial class Window1 : Window
{
  private void MouseRightButtonDown(object sender, MouseButtonEventArgs e)
  {
    MessageBox.Show(sender.GetType().Name);
    if (sender.GetType().Name == "StackPanel") e.Handled = true;
  }
}

很 有效，Border.MouseRightButtonDown 不在有效。严格来说，事件并没有被终止，它依然会继续传递个上级或下级的元素，只是 WPF 没有触发事件代码而已。我们可以使用 AddHandler 方法重新注册一个新的事件处理方法，使得可以继续处理被终止的事件(注意: 如果事件没有终止，这会导致两次事件处理)。

public partial class Window1 : Window
{
  public Window1()
  {
    InitializeComponent();

    this.border1.AddHandler(Border.MouseRightButtonDownEvent,
      new MouseButtonEventHandler(MouseRightButtonDown), true);
  }

  private void MouseRightButtonDown(object sender, MouseButtonEventArgs e)
  {
    MessageBox.Show(sender.GetType().Name);
    if (sender.GetType().Name == "StackPanel") e.Handled = true;
  }
}

再运行试试，你会发现 Border.MouseRightButtonDown 被触发了。

public void AddHandler(
  RoutedEvent routedEvent,
  Delegate handler,
  bool handledEventsToo
)

handledEventsToo: 如果为 true，则将按以下方式注册处理程序：即使路由事件在其事件数据中标记为已处理，也会调用该处理程序；如果为 false，则使用默认条件注册处理程序，即当路由事件被标记为已处理时，将不调用处理程序。

通常情况下，WPF 控件会在管道事件的名称前添加 Preview 前缀。

<Window x:Class="Learn.WPF.Window1"
  xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
  xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
  Title="Window1">
  <Grid>
    <Border PreviewMouseRightButtonDown="MouseRightButtonDown">
      <StackPanel PreviewMouseRightButtonDown="MouseRightButtonDown">
        <Button PreviewMouseRightButtonDown="MouseRightButtonDown">Test</Button>
      </StackPanel>
    </Border>
  </Grid>
</Window>

这回的输出结果正好跟前面的演示反过来，依次是 "Border"、"StackPanel"、"Button"。如果继续保留事件终止代码，那么 Button.PreviewMouseRightButtonDown 就不再被触发。

附加事件

和附加属性类似，WPF 允许我们在一个没有定义事件的元素上处理经管道或冒泡传递的路由事件。

Window1.xaml

<Window x:Class="Learn.WPF.Window1"
  xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
  xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
  Title="Window1">
  <Grid>
    <StackPanel Button.Click="Click">
      <Button>Test</Button>
    </StackPanel>
  </Grid>
</Window>

Window1.xaml.cs

public partial class Window1 : Window
{
  public Window1()
  {
    InitializeComponent();
  }

  private void Click(object sender, RoutedEventArgs e)
  {
    MessageBox.Show(e.Source.ToString());
  }
}

输出:
System.Windows.Controls.Button:Test

虽然 StackPanel 没有 Click 事件，但我们依然捕获了 Button 的点击事件，还有就是注意附加属性的写法。不要想当然认为该示例表示只有 Button 类型的子元素才会触发 Click 附加事件。

<Window x:Class="Learn.WPF.Window1"
  xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
  xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
  Title="Window1">
  <Grid>
    <StackPanel Button.Click="Click">
      <Button>Test</Button>
      <CheckBox>Check</CheckBox>
    </StackPanel>
  </Grid>
</Window>

很遗憾地告诉你，CheckBox 一样触发了 Click 附加事件。