EventHandler<TEventArgs> Delegát

Definice

Obor názvů:

System

Sestavení:

netstandard.dll, System.Runtime.dll

Zdroj:

EventHandler.cs

Představuje metodu, která bude zpracovávat událost, když událost poskytuje data.

generic <typename TEventArgs>
public delegate void EventHandler(System::Object ^ sender, TEventArgs e);

public delegate void EventHandler<in TEventArgs>(object? sender, TEventArgs e) where TEventArgs : allows ref struct;

type EventHandler<'EventArgs> = delegate of obj * 'EventArgs -> unit

Public Delegate Sub EventHandler(Of In TEventArgs)(sender As Object, e As TEventArgs)

Parametry typu

TEventArgs

Typ dat události vygenerovaných událostí.

Parametry

sender

Object

Zdroj události

e

TEventArgs

Objekt, který obsahuje data události.

Příklady

Následující příklad ukazuje událost s názvem ThresholdReached. Událost je přidružená k delegátu EventHandler<TEventArgs> .

using System;

namespace ConsoleApplication3
{
    public class Program3
    {
        public static void Main()
        {
            Counter c = new(new Random().Next(10));
            c.ThresholdReached += c_ThresholdReached;

            Console.WriteLine("press 'a' key to increase total");
            while (Console.ReadKey(true).KeyChar == 'a')
            {
                Console.WriteLine("adding one");
                c.Add(1);
            }
        }

        static void c_ThresholdReached(object? sender, ThresholdReachedEventArgs e)
        {
            Console.WriteLine("The threshold of {0} was reached at {1}.", e.Threshold,  e.TimeReached);
            Environment.Exit(0);
        }
    }

    class Counter
    {
        private readonly int _threshold;
        private int _total;

        public Counter(int passedThreshold)
        {
            _threshold = passedThreshold;
        }

        public void Add(int x)
        {
            _total += x;
            if (_total >= _threshold)
            {
                ThresholdReachedEventArgs args = new()
                {
                    Threshold = _threshold,
                    TimeReached = DateTime.Now
                };
                OnThresholdReached(args);
            }
        }

        protected virtual void OnThresholdReached(ThresholdReachedEventArgs e)
        {
            ThresholdReached?.Invoke(this, e);
        }

        public event EventHandler<ThresholdReachedEventArgs>? ThresholdReached;
    }

    public class ThresholdReachedEventArgs : EventArgs
    {
        public int Threshold { get; set; }
        public DateTime TimeReached { get; set; }
    }
}

open System

type ThresholdReachedEventArgs(threshold, timeReached) =
    inherit EventArgs()
    member _.Threshold = threshold
    member _.TimeReached = timeReached

type Counter(threshold) =
    let mutable total = 0

    let thresholdReached = Event<_>()

    member this.Add(x) =
        total <- total + x
        if total >= threshold then
            let args = ThresholdReachedEventArgs(threshold, DateTime.Now)
            thresholdReached.Trigger(this, args)

    [<CLIEvent>]
    member _.ThresholdReached = thresholdReached.Publish

let c_ThresholdReached(sender, e: ThresholdReachedEventArgs) =
    printfn $"The threshold of {e.Threshold} was reached at {e.TimeReached}."
    exit 0

let c = Counter(Random().Next 10)
c.ThresholdReached.Add c_ThresholdReached

printfn "press 'a' key to increase total"
while Console.ReadKey(true).KeyChar = 'a' do
    printfn "adding one"
    c.Add 1

Module Module1

    Sub Main()
        Dim c As Counter = New Counter(New Random().Next(10))
        AddHandler c.ThresholdReached, AddressOf c_ThresholdReached

        Console.WriteLine("press 'a' key to increase total")
        While Console.ReadKey(True).KeyChar = "a"
            Console.WriteLine("adding one")
            c.Add(1)
        End While
    End Sub

    Sub c_ThresholdReached(sender As Object, e As ThresholdReachedEventArgs)
        Console.WriteLine("The threshold of {0} was reached at {1}.", e.Threshold, e.TimeReached)
        Environment.Exit(0)
    End Sub
End Module

Class Counter
    Private threshold As Integer
    Private total As Integer

    Public Sub New(passedThreshold As Integer)
        threshold = passedThreshold
    End Sub

    Public Sub Add(x As Integer)
        total = total + x
        If (total >= threshold) Then
            Dim args As ThresholdReachedEventArgs = New ThresholdReachedEventArgs()
            args.Threshold = threshold
            args.TimeReached = DateTime.Now
            OnThresholdReached(args)
        End If
    End Sub

    Protected Overridable Sub OnThresholdReached(e As ThresholdReachedEventArgs)
        RaiseEvent ThresholdReached(Me, e)
    End Sub

    Public Event ThresholdReached As EventHandler(Of ThresholdReachedEventArgs)
End Class

Class ThresholdReachedEventArgs
    Inherits EventArgs

    Public Property Threshold As Integer
    Public Property TimeReached As DateTime
End Class

Poznámky

Model událostí v .NET je založený na tom, že má delegát události, který spojuje událost s jeho obslužnou rutinou. K vyvolání události jsou potřeba dva prvky:

• Delegát, který odkazuje na metodu, která poskytuje odpověď na událost.
• Volitelně je možné, že třída, která obsahuje data události, pokud událost poskytuje data.

Delegát je typ, který definuje podpis, tj. návratový typ hodnoty a typy seznamu parametrů pro metodu. Pomocí typu delegáta můžete deklarovat proměnnou, která může odkazovat na libovolnou metodu se stejným podpisem jako delegát.

Standardní podpis delegáta obslužné rutiny události definuje metodu, která nevrací hodnotu. První parametr této metody je typu Object a odkazuje na instanci, která vyvolá událost. Druhý parametr je odvozený z typu EventArgs a obsahuje data události. Pokud událost negeneruje data události, druhý parametr je jednoduše hodnota EventArgs.Empty pole. V opačném případě je druhým parametrem typ odvozený z EventArgs polí nebo vlastností potřebných k uložení dat události.

Delegát EventHandler<TEventArgs> je předdefinovaný delegát, který představuje metodu obslužné rutiny události pro událost, která generuje data. Výhodou použití EventHandler<TEventArgs> je, že pokud událost generuje data událostí, nemusíte kódovat vlastního delegáta. Jednoduše zadáte typ datového objektu události jako obecný parametr.

Chcete-li událost přidružit k metodě, která bude zpracovávat událost, přidejte instanci delegáta události. Obslužná rutina události se volá při každém výskytu události, pokud delegáta neodeberete.

Další informace o delegátech obslužné rutiny událostí naleznete v tématu Zpracování a vyvolávání událostí.

Metody rozšíření

Name	Description
GetMethodInfo(Delegate)	Získá objekt, který představuje metodu reprezentovanou zadaným delegátem.

Viz také

• EventHandler
• EventArgs
• Delegate
• Zpracování a vyvolávání událostí
• Postupy: Vyvolávání a využívání událostí
• Události (Visual Basic)
• Událost (Průvodce C# programováním)
• Události (F#)