C# 编程指南
如何:订阅和取消订阅事件(C# 编程指南)
如果您想编写引发事件时调用的自定义代码,则可以订阅由其他类发布的事件。例如,可以订阅某个按钮的“单击”事件,以使应用程序在用户单击该按钮时执行一些有用的操作。
使用 Visual Studio 2005 IDE 订阅事件
如果“属性”窗口不可见,请在“设计”视图中,右击要创建事件处理程序的窗体或控件,然后选择“属性”。
在“属性”窗口的顶部,单击“事件”图标。
双击要创建的事件,例如
Load 事件。
Visual C# 会创建一个空事件处理程序方法,并将其添加到您的代码中。或者,您也可以在“代码”视图中手动添加代码。例如,下面的代码行声明了一个在
Form 类引发
Load 事件时调用的事件处理程序方法。
C#
复制代码
private
void
Form1_Load(object sender, System.EventArgs e)
{
// Add your form load event handling code here.
}
订阅该事件所需的代码行也会在您项目的 Form1.Designer.cs 文件的
InitializeComponent 方法中自动生成。该代码行类似于:
复制代码
this.Load += new System.EventHandler(this.Form1_Load);
以编程方式订阅事件
定义一个事件处理程序方法,其签名与该事件的委托签名匹配。例如,如果事件基于
EventHandler委托类型,则下面的代码表示方法存根:
复制代码
void HandleCustomEvent(object sender, CustomEventArgs a)
{
// Do something useful here.
}
使用加法赋值运算符 (+=) 来为事件附加事件处理程序。在下面的示例中,假设名为
publisher 的对象拥有一个名为
RaiseCustomEvent 的事件。请注意,订户类需要引用发行者类才能订阅其事件。
复制代码
publisher.RaiseCustomEvent += HandleCustomEvent;
请注意,上面的语法是 C# 2.0 中的新语法。它完全等效于 C# 1.0 语法,必须使用以下新关键字显式创建封装委托:
复制代码
publisher.RaiseCustomEvent += new CustomEventHandler(HandleCustomEvent);
使用匿名方法订阅事件
使用加法赋值运算符 (+=) 来为事件附加匿名方法。在下面的示例中,假设名为
publisher 的对象拥有一个名为
RaiseCustomEvent 的事件,并且还定义了一个
CustomEventArgs 类以承载某些类型的专用事件信息。请注意,订户类需要引用
publisher 才能订阅其事件。
复制代码
publisher.RaiseCustomEvent += delegate(object o, CustomEventArgs e)
{
string s = o.ToString() + " " + e.ToString();
Console.WriteLine(s);
};
请注意,如果您是使用匿名方法订阅的事件,该事件的取消订阅过程就比较麻烦。此时要取消订阅,请返回到该事件的订阅代码,将该匿名方法存储在委托变量中,然后将委托添加到该事件中。
取消订阅
要防止在引发事件时调用事件处理程序,您只需取消订阅该事件。要防止资源泄露,请在释放订户对象之前取消订阅事件,这一点很重要。在取消订阅事件之前,在发布对象中作为该事件的基础的多路广播委托会引用封装了订户的事件处理程序的委托。只要发布对象包含该引用,就不会对订户对象执行垃圾回收。
取消订阅事件
使用减法赋值运算符 (-=) 取消订阅事件:
复制代码
publisher.RaiseCustomEvent -= HandleCustomEvent;
所有订户都取消订阅某事件后,发行者类中的事件实例会设置为 null。
(来源:msdn )