C# 8.0 イベントハンドラ登録時に、追加ではなく上書きしたい

Question

実現したいこと

C# イベントハンドラについての質問です。
イベントハンドラを登録する際、
FooInstance.FooEvent += FugaMethod();
のような書き方をすると思います。

上記は、イベントハンドラを追加している意味合いになると思いますが、
すでに登録されている場合、それを削除して新しく登録するような機能を求めています。

これは標準機能として存在しているのでしょうか？それとも、アクセサを明示的に実装するべきでしょうか？
もしそういった機能が標準で備わっているとしたら、自分では見つけられなかったのでドキュメントのリンクなどを貼っていただけると助かります。

補足情報（FW/ツールのバージョンなど）

Visual Studio 2022 C# 8.0

Comments

[YAmaGNZ]

https://teratail.com/questions/111336
この質問が参考になりませんか？

[Zuishin]

-= で削除できます。

Answer 1

すでに登録されている場合、それを削除して新しく登録するような機能を求めています。

不要となったデリゲートを -= で削除できます。

昔の Microsoft のチュートリアル（今はリンク切れ）に自分的に参考になったコードがあるので以下に貼っておきます。コメントは私が追加したものなので、信ぴょう性がイマイチかもしれないのでご注意を。

// イベントとは、オブジェクトでクライアントに有益な事象が発生したときに、クラスからクライ
// アントへ通知する方法のこと。
//  
// イベント使用の典型的な例は Windows フォームのコントロール。通常、インターフェイスのコ
// ントロールを表すクラスには、ユーザーがコントロールに対して何らかの操作 (ボタンのクリッ
// クなど) を行ったときに通知されるイベントが設定されている。 
//
// イベントの宣言には、デリゲートを使用する。イベントが発生すると、クライアントによって
// フックされたデリゲートが呼び出される。

// 2015/2/7 以下のページを見つけたのでメモしておく：
// 方法 : .NET Framework ガイドラインに準拠したイベントを発行する (C# プログラミング ガイド)
// https://docs.microsoft.com/ja-jp/dotnet/csharp/programming-guide/events/how-to-publish-events-that-conform-to-net-framework-guidelines

// 方法 : 派生クラスから基本クラス イベントを発生させる (C# プログラミング ガイド)
// https://docs.microsoft.com/ja-jp/dotnet/csharp/programming-guide/events/how-to-raise-base-class-events-in-derived-classes

using System;
using System.Collections;

namespace MyEventTest
{
    // 宣言されていない場合は、最初にイベントのデリゲート型を宣言する必要がある。sender 
    // はイベントが発生したオブジェクトへの参照。e はイベントデータが格納されているオブ
    // ジェクトへの参照。
    // ライブラリの EventHandler を使う場合は、宣言済みらしく、この宣言は不用。
    // 引数はライブラリの EventHandler と合わせているが、このサンプルでは使っていないの
    // で、ChangeEventHandler(引数なし) として書き直しても同じ結果になる。

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

    public class ListWithChangedEvent : ArrayList
    {
        // イベントの宣言
        // event キーワードに注意。
        // クラスの外からはフィールドのように見える。ただし、アクセスには制限があり、実行で
        // きるのは、以下の処理だけ。
        // 　・新しいデリゲートの結合
        //   ・(結合されている場合は)デリゲートの削除
        // これらの処理には、+= および -= 演算子を使用する。下記の EventListener クラス参照

        public event ChangedEventHandler Changed;

        // イベントの起動
        // デリゲートをイベントにフックしているクライアントがない場合、フィールドは null に
        // なる。それ以外の場合は、イベント起動時に呼び出すデリゲートへの参照となる。このた
        // め、一般にイベントが起動される場合はまずこのフィールドが null かどうかを調べ、そ
        // の後イベントを呼び出す。

        // イベントは、イベントを宣言したクラスの中からしか起動できない。イベントを起動する
        // protected メソッドを作成しておき、このメソッドを呼び出すことによって、派生クラスが
        // イベントを起動できる。さらに柔軟性を持たせるために、起動メソッドを virtual とし
        // て宣言することも多くある。これにより、派生クラスは、そのメソッドをオーバーライド
        // できる。
        protected virtual void OnChanged(EventArgs e)
        {
            if (Changed != null)
                Changed(this, e);
        }

        // リストへの追加、リストのクリア、リストの要素への代入の際にイベントを起動（具体的
        // には EventListener が Changed に結合したメソッド ListChanged を呼ぶ）。
        public override int Add(object value)
        {
            int i = base.Add(value);
            OnChanged(EventArgs.Empty); // Empty の他に何がある？？←無い。下記の説明を参照
            return i;
        }
        // ＜ヘルプの EventArgs クラスの説明＞
        // このクラスにはイベント データは格納されません。このクラスは、イベントの発生時にス
        // テータス情報をイベントハンドラに渡さないイベントによって使用されます。イベントハン
        // ドラがステータス情報を必要とする場合、アプリケーションは、そのデータを保持するため
        // に、このクラスからクラスを派生させる必要があります。

        public override void Clear()
        {
            base.Clear();
            OnChanged(EventArgs.Empty);
        }

        public override object this[int index]
        {
            set
            {
                base[index] = value;
                OnChanged(EventArgs.Empty);
            }
        }
    }
}

namespace TestEvents
{
    using MyEventTest;

    class EventListener
    {
        private ListWithChangedEvent List;

        // イベントのフック
        // イベントの呼び出しの受け取りを開始するには、クライアントコードはまず、イベント
        // から呼び出されるメソッドを参照するイベント型のデリゲート（以下のコードで言うと、
        // new ChangedEventHandler(ListChanged) ）を作成する。
        // 次に、+= を使用して、イベントに接続される他のデリゲートに、このデリゲートを結
        // 合する。 
        public EventListener(ListWithChangedEvent list)
        {
            List = list;
            List.Changed += new ChangedEventHandler(ListChanged);
        }

        // イベントから呼び出されるメソッド。
        private void ListChanged(object sender, EventArgs e)
        {
            Console.WriteLine("This is called when the event fires.");
        }

        // クライアントコードは、-= 演算子を使用してイベントからデリゲートを削除できる。 
        public void Detach()
        {
            List.Changed -= new ChangedEventHandler(ListChanged);
            List = null;
        }
    }

    // サンプルプログラムにもう一人 Listener を追加
    class AnotherEventListener
    {
        private ListWithChangedEvent List;

        public AnotherEventListener(ListWithChangedEvent list)
        {
            List = list;
            List.Changed += new ChangedEventHandler(ListChanged);
        }

        private void ListChanged(object sender, EventArgs e)
        {
            Console.WriteLine("追加したもう一人の Listener に通知");
        }

        public void Detach()
        {
            List.Changed -= new ChangedEventHandler(ListChanged);
            List = null;
        }
    }

    class Test
    {
        public static void Main()
        {
            ListWithChangedEvent list = new ListWithChangedEvent();

            EventListener listener = new EventListener(list);
            AnotherEventListener anotherListener = new AnotherEventListener(list);

            list.Add("item 1");
            list.Clear();
            listener.Detach();  // += した順に関係なく、不要となったデリゲートを -= で削除できる
            list.Add("item 2");
            list.Clear();
            anotherListener.Detach();

            list.Changed += List_Changed;
            list.Add("item 3");
        }

        private static void List_Changed(object sender, EventArgs e)
        {
            Console.WriteLine("item 3 が追加された"); ;
        }
    }
}


// C# 言語では任意のデリゲート型のイベントを使用できるが、.NET Framework ではイベントに使用で
// きるデリゲート型に厳密なガイドラインがある。適正なデリゲート型の EventHandler が .NET 
// Framework によって既に定義されている。上記のサンプルで、イベントのデリゲート型を宣言を削除
// し、ChangedEventHandler を EventHandler と書き直せばよい。

Comments

[Hottopia]

ありがとうございました。参考にさせていただきます。

Answer 2

自分がfoo classを実装しているなら、eventである必要がないような。delegate型のメンバーを直接公開しては？

Comments

[Zuishin]

変わったことをすると可読性が落ちます。