为自定义控件添加自定义事件
事件,委托,总是看起来有点绕,不过本文不介绍这些,只说说如何为自定义控件添加自定义事件。
本文所说的自定义控件,非继承其他现有Microsoft控件或者组合控件,而是完全继承UserControl的东西。
既然不是继承自其他现有控件或者控件组合,在特定需求下,有添加自定义事件的可能性,或者对继承自UserControl而得到的事件进行些许扩展,以期以简便的方式得到更丰富的信息等等。
下面简单介绍2个例子,有用之人作为参考,大拿级别的,ignore吧。
例1. 添加完全自定义事件。
需求:
好吧,起个名字,叫Custom,需要客户端在触发Custom时得到一个布尔属性Flag来判断用户是否按下Shift。
按部就班:
(1)创建事件
// 创建事件
public event CustomEventHandler Custom;
(2)定义委托
// 定义委托
public delegate void CustomEventHandler(object sender, CustomEventArgs e);
CustomEventHandler搞定了,又有新问题:CustomEventArgs是啥,其实需要CustomEventArgs来获得你需要的数据,CustomEventHandler,于是还要定义个CustomEventArgs(这个东西必须继承自System.EventArgs),在CustomEventArgs里面定义需要的数据属性:
(3)定义EventArgs
// 自定义EventArgs,并添加自定义属性【Flag】
public sealed class CustomEventArgs : EventArgs
{
private bool testFlag;
public CustomEventArgs(bool testFlag)
{
this.testFlag = testFlag;
}
public bool Flag
{
get { return testFlag; }
}
}
有了CustomEventArgs,以后在触发事件之后便可以从e.Flag中得到数据。
能看到在属性窗口中已经能见到Custom事件
可是Custom到底是怎么执行和在控件内部触发的呢,想破头~
(4)执行事件的代码
需要一个OnCustom来完成任务
// 执行事件
protected virtual void OnCustom(CustomEventArgs e)
{
if (Custom != null)
{
Custom(this, e);
}
}
Custom(this, e);
来完成调动客户端的任务,现在问题的关键就在于在合适的地方执行一下OnCustom就可以了,在何处执行,全看你需要的数据在什么地方能后取得或者发生变化,本例简单点,就在控件本身的KeyDown事件里面好了:
(5)何处执行OnCustom
// 触发事件处
private void MyControl_KeyDown(object sender, KeyEventArgs e)
{
// 此处省略无关代码。。。
// 客户端按下Shift键与否
bool testFlag = e.Shift;
CustomEventArgs eArgs = new CustomEventArgs(testFlag);
// 触发事件
OnCustom(eArgs);
// 此处省略无关代码。。。
}
在测试窗体上使用自定义控件的Custom事件
例2.对原有事件进行一定扩展,并覆盖原事件
需求:
想在KeyPress中再多获得一些数据,起个名字:KeyAscii,但是KeyPress中没有这个,那就自定义一个CustomKeyPress,不用KeyPress,并使其在客户端隐藏
隐藏的办法:
// 屏蔽KeyPress事件使其在客户端不可见
[Browsable(false)]
public new event KeyPressEventHandler KeyPress;
以后跟例一差不多了,
创建事件,委托:
// 创建事件CustomKeyPress替代KeyPress
public event CustomKeyPressEventHandler CustomKeyPress;
// 定义委托
public delegate void CustomKeyPressEventHandler(object sender, CustomKeyPressEventArgs e);
CustomKeyPressEventArgs要继承自KeyPressEventArgs,而System.Windows.Forms.KeyPressEventArgs其实继承自System.EventArgs
// 自定义KeyPressEventArgs,并添加自定义属性【KeyAscii】
public sealed class CustomKeyPressEventArgs : KeyPressEventArgs
{
private Int32 keyAscii;
public CustomKeyPressEventArgs(Int32 keyAscii) : base((char)keyAscii)
{
this.keyAscii = keyAscii;
}
public Int32 KeyAscii
{
get { return keyAscii; }
}
}
触发事件处:
// 触发事件处
protected override void OnKeyPress(KeyPressEventArgs e)
{
if (CustomKeyPress != null)
{
CustomKeyPressEventArgs eArgs = new CustomKeyPressEventArgs(e.KeyChar);
CustomKeyPress(this, eArgs);
}
base.OnKeyPress(e);
}
需要特别注意的是,KeyPress被隐藏之后,控件本身的KeyPress事件也将不能被触发
OK....