WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / C#

System.EventHandler<TEventArgs> und System.EventArgs

Wähle den passenden Delegattyp für ein Ereignis mit oder ohne Daten und entferne nicht mehr benötigte Ereignishandler.

Version: C# 12 and .NET 8; later runtimes may add compatible features

Syntax

// .NET 8 delegate signatures in namespace System (already provided by .NET):
public delegate void EventHandler<TEventArgs>(object? sender, TEventArgs e);
public delegate void EventHandler(object? sender, EventArgs e);

// In a publisher class, with using System; and a custom MessageEventArgs : EventArgs:
public event EventHandler<MessageEventArgs>? MessagePublished;
public event EventHandler? Flushed;

// Inside an instance method of that publisher:
MessagePublished?.Invoke(this, new MessageEventArgs("Build complete"));
Flushed?.Invoke(this, EventArgs.Empty);

Mit dem Delegattyp System.EventHandler<TEventArgs> deklarierst du ein Ereignis, das Daten übermittelt. Ein Handler gibt void zurück und erhält object? sender, normalerweise das auslösende Objekt (der Wert kann null sein), und TEventArgs e. System.EventArgs ist eine Basisklasse für Ereignisdaten, kein Delegat. In C# 12 mit .NET 8 verlangt der Delegat nicht, dass TEventArgs von EventArgs erbt. Für eigene Ereignisdatenklassen ist das aber die übliche .NET-Konvention.

Deklariere MessagePublished in einer Benachrichtigungszentrale mit EventHandler<MessageEventArgs>. Die Klasse MessageEventArgs : EventArgs bietet die schreibgeschützte Eigenschaft Message, sodass ein Handler e.Message ohne Typumwandlung lesen kann. Verwende für Flushed den separaten nicht generischen Typ System.EventHandler: Der zweite Parameter hat weiterhin den Typ EventArgs. Der Herausgeber übergibt EventArgs.Empty, eine gemeinsam verwendete Instanz ohne zusätzliche Daten, statt null.

Externer Code meldet Handler mit += an und mit -= ab, kann das Ereignis aber nicht direkt auslösen. Die deklarierende Klasse löst es mit ?.Invoke(this, e) aus; ohne Abonnenten findet kein Aufruf statt. Ein gewöhnlicher Delegataufruf läuft synchron. Wirft ein Handler eine Ausnahme, die er nicht abfängt, wird sie an den Aufrufer weitergegeben, und nachfolgende Handler in der Aufrufliste werden übersprungen.

Verwende beim An- und Abmelden dieselbe Methode. Bei einem Lambda speicherst du den Delegaten, den du zur Anmeldung verwendet hast. Melde Handler ab, wenn du keine Benachrichtigungen mehr brauchst, besonders wenn der Herausgeber länger lebt als der Abonnent: Sein Delegat kann das Abonnentenobjekt am Leben halten.

Beispiele

#nullable enable
using System;

var hub = new NotificationHub();
hub.MessagePublished += OnMessagePublished;
hub.Flushed += OnFlushed;

hub.Publish("Build complete");
hub.Flush();

hub.MessagePublished -= OnMessagePublished;
hub.Flushed -= OnFlushed;

hub.Publish("Not printed");
hub.Flush();

static void OnMessagePublished(object? sender, MessageEventArgs e)
    => Console.WriteLine(e.Message);

static void OnFlushed(object? sender, EventArgs e)
    => Console.WriteLine("Flushed");

sealed class MessageEventArgs : EventArgs
{
    public MessageEventArgs(string message) => Message = message;

    public string Message { get; }
}

sealed class NotificationHub
{
    public event EventHandler<MessageEventArgs>? MessagePublished;
    public event EventHandler? Flushed;

    public void Publish(string message)
        => MessagePublished?.Invoke(this, new MessageEventArgs(message));

    public void Flush()
        => Flushed?.Invoke(this, EventArgs.Empty);
}

Ergebnis

Build complete
Flushed

`NotificationHub` stellt zwei unabhängige Ereignisse bereit. Die ersten Aufrufe von `Publish` und `Flush` geben `Build complete` bzw. `Flushed` aus. Nach dem Abmelden beider Handler erzeugen die nächsten Aufrufe keine Ausgabe.

Zugehörige Lektionen

  • C# · Lektion 23 · Mittlere Stufe · Version: 2
  • C# · Lektion 24 · Mittlere Stufe · Version: 2
  • C# · Lektion 25 · Mittlere Stufe · Version: 2

Quellen