自定义路由事件的添加,共分为三个步骤:
1、声明并注册路由事件
2、为路由事件添加CLR事件包装
3、创建可以激发路由事件的方法
以下实例,实现的功能是创建一个Button,每次点击该Button时激发自定义的路由事件ReportTime,传递按钮被点击的时间。
首先定义用于承载时间消息的事件参数,主要充当在事件中传递的参数的载体,必须继承自EventArgs类:
public class ReportTimeEventArgs : RoutedEventArgs
{
public ReportTimeEventArgs(RoutedEvent rountedEvent,object source):
base(rountedEvent,source)
{
}
public DateTime ClickTime { get; set; }
}
将按钮点击的时间放到ReportTimeEventArgs类中,在激发路由事件时,事件传递的参数就是ReportTimeEventArgs类对象,而该对象保存这按钮被点击的时间。看其构造函数的两个参数一个是路由事件的对象,另一个是该路由事件的宿主。
接下来,从Button继承一个类,分别按照上述三个步骤添加自定义的路由事件:
class TimeButton:Button
{
//声¦¨´明¡Â和¨ª注Á¡é册¨¢路¡¤由®¨¦事º?件t
public static readonly RoutedEvent ReportTimeEvent = EventManager.RegisterRoutedEvent
("ReportTime", RoutingStrategy.Bubble, typeof(EventHandler< ReportTimeEventArgs
>), typeof(TimeButton));
//CLR事º?件t包㨹装Á¡ã器¡Â
public event RoutedEventHandler ReportTime
{
add { this.AddHandler(ReportTimeEvent,value);}
remove { this.RemoveHandler(ReportTimeEvent, value); }
}
//激¡è发¤¡é路¡¤由®¨¦事º?件t,ê?用®?Click的Ì?方¤?法¤¡§
protected override void OnClick()
{
base.OnClick();
ReportTimeEventArgs args = new ReportTimeEventArgs(ReportTimeEvent, this);
args.ClickTime = DateTime.Now;
this.RaiseEvent(args);
}
}
来看声明和注册的路由事件,和依赖属性类似,该路由事件也是static的和readoly的,也就是说是全局范围内的对象,其注册函数包含四个参数,分别是:将会被封装成的CLR事件包装器名称;路由事件的传递方式,是向下逐级传递,还是向上逐级传递,还是有目标的一次性传递;事件处理器的类型;宿主类型。
接下来看CLR事件的包装器,不同于依赖属性的SetValue和GetValue,这里是利用add和Remove两个函数来给路由事件分配事件处理器。
在Button类中的OnClick函数中,我们激发该路由事件。首先声明了一个传递路由事件参数的ReportTimeEventArgs类对象,其后遭器由路由事件和Button的this构成,将其ClickTime属性赋值为当前点击的时间,然后通过RaiseEvent这一虚函数激发该事件。RaiseEvent的参数是RoutedEventArgs类型对象,而在该对象中包含了这个全局的路由事件和事件宿主信息。当该在事件传递的路由节点中,如果配置了针对该事件的处理器,该节点就能从全局找到该事件并进行相应操作。
搭建以下界面,每点击一次按钮,就会在ListBox上显示按钮被点击的事件:
<Window x:Class="_8._10.MainWindow"
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
xmlns:local="clr-namespace:_8._10"
Title="MainWindow" Height="350" Width="525"
local:TimeButton.ReportTime="ReportTimeHandler" x:Name="window">
<Grid local:TimeButton.ReportTime="ReportTimeHandler" Name="grid">
<StackPanel local:TimeButton.ReportTime="ReportTimeHandler" Name="stackpanel">
<ListBox Width="400" Height="220" Name="list" />
<local:TimeButton x:Name="timebutton" Width="40" Height="80" Content="报À¡§时º¡À" local:TimeButton.ReportTime="ReportTimeHandler"/>
</StackPanel>
</Grid>
</Window>
点击按钮,效果如下: