WPF(路由事件)
路由事件是具有更强传播能力的事件——它们可在元素树中向上冒泡和向下隧道传播,并且沿着传播路径被事件处理程序处理。路由事件允许事件在某个元素上被处理,即使该事件源自另一个元素也是如此。
WPF总是遵循一下顺序:首先设置 Name 属性(如果设置的话),然后关联任意事件处理程序,最后设置属性。这意味着,所有对属性变化做出响应的事件处理程序在第一次设置属性时都会被触发。
路由事件以以下三种方式出现:
- 与普通.Net事件类似的直接路由事件(direct event)。它们源自一个元素,不传递给其他元素。例如,MouseEnter事件是直接路由事件(当鼠标指针移到元素上时发生)。
- 在包含层次中向上传递的冒泡路由事件(bubbling event)。例如,MouseDown事件就是冒泡路由事件。该事件首先由被单击的元素引发,接下来被元素的父元素引发,然后被父元素的父元素引发,依次类推,直到WPF到达元素树的顶部为止。
- 在包含层次中向下传递的隧道路由事件(tunneling event)。隧道路由事件在事件到达恰当的控件之前为预览事件(甚至终止事件)提供机会。例如,通过PreviewKeyDown事件可截获是否按下了某个键。首先在窗口级别上,然后是更具体的容器,直至到达当按下键时具有焦点的元素。
事件注册为哪种事件,由RoutingStrategy枚举决定:
Tunnel | 路由事件使用隧道策略,以便事件实例通过树向下路由(从根到源元素)。 |
Bubble | 路由事件使用冒泡策略,以便事件实例通过树向上路由(从事件元素到根)。 |
Direct | 路由事件不通过元素树路由,但支持其他路由的事件功能。 |
直接路由事件
namespace WpfApp2
{
using System.Windows;
using System.Windows.Controls;
public class Btn1 : Button
{
public static readonly RoutedEvent PressEvent;
static Btn1()
{
PressEvent = EventManager.RegisterRoutedEvent(nameof(Press),
RoutingStrategy.Direct, typeof(RoutedEventHandler), typeof(Btn1));
}
public event RoutedEventHandler Press
{
add { base.AddHandler(PressEvent, value); }
remove { base.RemoveHandler(PressEvent, value); }
}
}
public class Btn2 : Btn1
{
}
}
<Window x:Class="WpfApp2.MainWindow"
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
xmlns:local="clr-namespace:WpfApp2"
mc:Ignorable="d"
Title="MainWindow" Height="450" Width="800">
<Grid>
<local:Btn1 Background="Gold" Press="Btn1_Press" Click="Btn1_Click">
<local:Btn2 Background="Red" Content="666" Press="Btn2_Press" Click="Btn2_Click"/>
</local:Btn1>
</Grid>
</Window>
namespace WpfApp2
{
using System.Windows;
/// <summary>
/// MainWindow.xaml 的交互逻辑
/// </summary>
public partial class MainWindow : Window
{
public MainWindow()
{
InitializeComponent();
}
private void Btn1_Press(object sender, RoutedEventArgs e)
{
}
private void Btn2_Press(object sender, RoutedEventArgs e)
{
}
private void Btn2_Click(object sender, RoutedEventArgs e)
{
Btn2 btn2 = sender as Btn2;
btn2.RaiseEvent(new RoutedEventArgs(Btn2.PressEvent));
}
private void Btn1_Click(object sender, RoutedEventArgs e)
{
if (!(e.OriginalSource is Btn2)) //防止Btn2路由进去
{
Btn1 btn1 = sender as Btn1;
btn1.RaiseEvent(new RoutedEventArgs(Btn1.PressEvent));
}
}
}
}
测试结果:
- 点击Btn1 (Btn1_Click => Btn1_Press)
- 点击Btn2 (Btn2_Click => Btn2_Press => Btn1_Click)(因为Click事件是冒泡路由事件,所以点击Btn2也会触发Btn1的Click事件)
冒泡路由事件
只需要在注册事件时,将RoutingStrategy设置为Bubble。
namespace WpfApp2
{
using System.Windows;
using System.Windows.Controls;
public class Btn1 : Button
{
public static readonly RoutedEvent PressEvent;
static Btn1()
{
PressEvent = EventManager.RegisterRoutedEvent(nameof(Press),
RoutingStrategy.Bubble, typeof(RoutedEventHandler), typeof(Btn1));
}
public event RoutedEventHandler Press
{
add { base.AddHandler(PressEvent, value); }
remove { base.RemoveHandler(PressEvent, value); }
}
}
public class Btn2 : Btn1
{
}
}
测试结果:
- 点击Btn1 (Btn1_Click => Btn1_Press)
- 点击Btn2 (Btn2_Click => Btn2_Press => Btn1_Press => Btn1_Click)
隧道路由事件
隧道路由事件的工作方式和冒泡路由事件相同,但方向相反。 当触发内层元素的隧道事件,先不引发该事件方法,先会引发最上层的,依次往下,直至到达该元素。
隧道路由事件应都以单词Preview开头,我这里就没有按照该标准,自己开发时最好按照该规定,方便管理。而且,WPF通常成对地定义冒泡和隧道路由事件,这意味这如果发现冒泡的MouseUp事件,就可以找到PreviewMouseUp隧道事件。隧道路由事件总在冒泡路由事件之前被触发,并且若是将隧道路由事件标记为已处理过,那就不会发生冒泡路由事件了,这是因为两个事件共享RoutedEventArgs类(将该实例的Handled属性设置为True表示已处理过,不会继续冒泡或者隧道)的同一个实例。
namespace WpfApp2
{
using System.Windows;
using System.Windows.Controls;
public class Btn1 : Button
{
public static readonly RoutedEvent PressEvent;
static Btn1()
{
PressEvent = EventManager.RegisterRoutedEvent(nameof(Press),
RoutingStrategy.Tunnel, typeof(RoutedEventHandler), typeof(Btn1));
}
public event RoutedEventHandler Press
{
add { base.AddHandler(PressEvent, value); }
remove { base.RemoveHandler(PressEvent, value); }
}
}
public class Btn2 : Btn1
{
}
}
测试结果:
- 点击Btn1 (Btn1_Click => Btn1_Press)
- 点击Btn2 (Btn2_Click => Btn1_Press => Btn2_Press => Btn1_Click
共享路由事件
这里是用了继承才可以让事件在两个元素之间冒泡或者隧道,若是两个元素之间没有继承关系时如何冒泡或隧道???我们可以利用共享事件达到一样的效果。
将Btn2修改成如下的代码: PressEvent和Press的命名可以不一样。
public class Btn2 : Button
{
public static readonly RoutedEvent PressEvent;
static Btn2()
{
PressEvent = Btn1.PressEvent.AddOwner(typeof(Btn2));
}
public event RoutedEventHandler Press
{
add { base.AddHandler(PressEvent, value); }
remove { base.RemoveHandler(PressEvent, value); }
}
}
附加事件
<Window x:Class="WpfApp2.MainWindow"
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
xmlns:local="clr-namespace:WpfApp2"
xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
Title="MainWindow" Width="800" Height="450" mc:Ignorable="d">
<StackPanel x:Name="stackPanel" local:Btn1.Press="StackPanel_Press">
<local:Btn1 Background="Gold" Click="Btn1_Click" Content="777" />
<local:Btn2 Background="Red" Click="Btn2_Click" Content="666" />
</StackPanel>
</Window>
当Btn1或者Btn2触发Press事件时都会引发StackPanel_Press方法。
当用代码中关联附加事件时,需要使用 UIElement.AddHandler()方法,而不能使用+=运算符语法。
this.stackPanel.AddHandler(Btn1.PressEvent, new RoutedEventHandler(StackPanel_Press));