如何：發布符合 .NET Framework 準則的事件（C# 編程指南） · MSDN C# 編程指南 & 參考手冊 2015

# 如何：發布符合 .NET Framework 準則的事件（C# 編程指南）下面的過程演示了如何將符合標準 .NET Framework 模式的事件添加到您的類和結構中。.NET Framework 類庫中的所有事件均基于 [EventHandler](https://msdn.microsoft.com/zh-cn/library/system.eventhandler.aspx) 委托，定義如下： ``` public delegate void EventHandler(object sender, EventArgs e); ``` | ![](https://box.kancloud.cn/2016-01-31_56adb62c1380a.jpg) 注意 | | :-- | | .NET Framework 2.0 引入了此委托的一個泛型版本，即 [EventHandler<TEventArgs>](https://msdn.microsoft.com/zh-cn/library/db0etb8x.aspx)。下面的示例顯示如何使用這兩種版本。 | 雖然您定義的類中的事件可基于任何有效委托類型（甚至是可返回值的委托），但是，通常建議您使用 [EventHandler](https://msdn.microsoft.com/zh-cn/library/system.eventhandler.aspx) 讓事件基于 .NET Framework 模式，如下面的示例所示。 ## 采用 EventHandler 模式發布事件 1. （如果不需要與事件一起發送自定義數據，請跳過此步驟，進入步驟 3a。）在發行者類和訂閱方類均可看見的范圍中聲明自定義數據的類。然后添加保留您的自定義事件數據所需的成員。在此示例中，會返回一個簡單字符串。 ``` public class CustomEventArgs : EventArgs { public CustomEventArgs(string s) { msg = s; } private string msg; public string Message { get { return msg; } } } ``` 2. （如果您使用的是 [EventHandler<TEventArgs>](https://msdn.microsoft.com/zh-cn/library/db0etb8x.aspx) 的泛型版本，請跳過此步驟。）在發布類中聲明一個委托。為它指定以 EventHandler 結尾的名稱。第二個參數指定自定義 EventArgs 類型。 ``` public delegate void CustomEventHandler(object sender, CustomEventArgs a); ``` 3. 使用以下任一步驟，在發布類中聲明事件。 1. 如果沒有自定義 EventArgs 類，事件類型就是非泛型 EventHandler 委托。無需聲明委托，因為它已在創建 C# 項目時包含的 [System](https://msdn.microsoft.com/zh-cn/library/system.aspx) 命名空間中進行了聲明。將以下代碼添加到發行者類中。 ``` public event EventHandler RaiseCustomEvent; ``` 2. 如果使用的是 [EventHandler](https://msdn.microsoft.com/zh-cn/library/system.eventhandler.aspx) 的非泛型版本，并且您有一個由 [EventArgs](https://msdn.microsoft.com/zh-cn/library/system.eventargs.aspx) 派生的自定義類，請在發布類中聲明您的事件，并且將來自步驟 2 的委托用作類型。 ``` public event CustomEventHandler RaiseCustomEvent; ``` 3. 如果使用的是泛型版本，則不需要自定義委托。相反，在發行者類中，您應將事件類型指定為 EventHandler<CustomEventArgs>，將尖括號中的內容替換為自己的類的名稱。 ``` public event EventHandler<CustomEventArgs> RaiseCustomEvent; ``` 下面的示例通過將自定義 EventArgs 類和 [EventHandler<TEventArgs>](https://msdn.microsoft.com/zh-cn/library/db0etb8x.aspx) 用作事件類型來演示上述步驟。 ``` namespace DotNetEvents { using System; using System.Collections.Generic; // Define a class to hold custom event info public class CustomEventArgs : EventArgs { public CustomEventArgs(string s) { message = s; } private string message; public string Message { get { return message; } set { message = value; } } } // Class that publishes an event class Publisher { // Declare the event using EventHandler<T> public event EventHandler<CustomEventArgs> RaiseCustomEvent; public void DoSomething() { // Write some code that does something useful here // then raise the event. You can also raise an event // before you execute a block of code. OnRaiseCustomEvent(new CustomEventArgs("Did something")); } // Wrap event invocations inside a protected virtual method // to allow derived classes to override the event invocation behavior protected virtual void OnRaiseCustomEvent(CustomEventArgs e) { // Make a temporary copy of the event to avoid possibility of // a race condition if the last subscriber unsubscribes // immediately after the null check and before the event is raised. EventHandler<CustomEventArgs> handler = RaiseCustomEvent; // Event will be null if there are no subscribers if (handler != null) { // Format the string to send inside the CustomEventArgs parameter e.Message += String.Format(" at {0}", DateTime.Now.ToString()); // Use the () operator to raise the event. handler(this, e); } } } //Class that subscribes to an event class Subscriber { private string id; public Subscriber(string ID, Publisher pub) { id = ID; // Subscribe to the event using C# 2.0 syntax pub.RaiseCustomEvent += HandleCustomEvent; } // Define what actions to take when the event is raised. void HandleCustomEvent(object sender, CustomEventArgs e) { Console.WriteLine(id + " received this message: {0}", e.Message); } } class Program { static void Main(string[] args) { Publisher pub = new Publisher(); Subscriber sub1 = new Subscriber("sub1", pub); Subscriber sub2 = new Subscriber("sub2", pub); // Call the method that raises the event. pub.DoSomething(); // Keep the console window open Console.WriteLine("Press Enter to close this window."); Console.ReadLine(); } } } ``` ## 請參閱 [Delegate](https://msdn.microsoft.com/zh-cn/library/system.delegate.aspx) [C# 編程指南](https://msdn.microsoft.com/zh-cn/library/67ef8sbd.aspx) [事件（C# 編程指南）](https://msdn.microsoft.com/zh-cn/library/awbftdfh.aspx) [委托（C# 編程指南）](https://msdn.microsoft.com/zh-cn/library/ms173171.aspx)