方法 : .NET Framework ガイドラインに準拠したイベントを発行する (C# プログラミングガイド)

[アーティクル]
10/10/2008

更新 : 2007 年 11 月

次の例では、.NET Framework の標準のパターンに従うイベントを固有のクラスおよび構造体に追加する方法を示します。.NET Framework クラスライブラリ内のすべてのイベントは、次のように定義されている EventHandler デリゲートに基づいています。

public delegate void EventHandler(object sender, EventArgs e);

メモ :
.NET Framework 2.0 には、このデリゲートのジェネリックバージョンである EventHandler<TEventArgs> が導入されています。次の例では、両方のバージョンの使用方法を示します。

ユーザー定義のクラス内のイベントは、値を返すデリゲートを含む、あらゆる有効なデリゲートを基にすることができますが、一般には、次の例のように EventHandler を使用して、.NET Framework のパターンを基にすることをお勧めします。

EventHandler パターンに基づいてイベントを発行するには

イベントと共にカスタムデータを送信する必要がない場合は、この手順を省略し、手順 3a. に進んでください。パブリッシャクラスとサブスクライバクラスの両方から認識できるスコープでクラスを宣言し、カスタムイベントデータを格納するために必要なメンバを追加します。この例では、単純な文字列が 1 つ返されます。
```
public class CustomEventArgs : EventArgs
{
    public CustomEventArgs(string s)
    {
        msg = s;
    }
    private string msg;
    public string Message
    {
        get { return msg; }
    } 
}
```
ジェネリックバージョンの EventHandler<TEventArgs> を使用する場合、この手順は省略します。パブリッシャクラス内にデリゲートを宣言します。EventHandler で終わる名前を指定します。2 番目のパラメータに、カスタムの EventArgs 型を指定します。
```
public delegate void CustomEventHandler(object sender, CustomEventArgs a);
```
次のいずれかの手順で、パブリッシャクラス内にイベントを宣言します。
1. カスタムの EventArgs クラスがない場合、Event 型は非ジェネリックバージョンの EventHandler デリゲートになります。このデリゲートは、C# プロジェクトを作成したときに含まれている System 名前空間内に既に宣言されているため、ここで宣言する必要はありません。
```
public event EventHandler RaiseCustomEvent;
```
2. 非ジェネリックバージョンの EventHandler を使用し、EventArgs から派生したカスタムクラスがある場合は、パブリッシャクラス内のイベントを宣言し、デリゲートを型として使用します。
```
class Publisher
{
    public event CustomEventHandler RaiseCustomEvent;
}
```
3. ジェネリックバージョンを使用する場合、カスタムデリゲートは不要です。代わりに、イベントの型として、EventHandler<CustomEventArgs> を指定します。角かっこの部分は、実際のクラス名で置き換えます。
```
public event EventHandler<CustomEventArgs> RaiseCustomEvent;
```

使用例

次に示すのは、前の手順の具体例です。カスタムの EventArgs クラスを使用し、イベントの型としては EventHandler<TEventArgs> を指定します。

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();

        }
    }
}