EventHandler<TEventArgs> Делегат

Определение

Пространство имен:

System

Сборка:

mscorlib.dll

Представляет метод, который будет обрабатывать событие, когда событие предоставляет данные.

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

[System.Serializable]
public delegate void EventHandler<TEventArgs>(object sender, TEventArgs e);

[<System.Serializable>]
type EventHandler<'EventArgs> = delegate of obj * 'EventArgs -> unit

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

Параметры типа

TEventArgs

Тип данных события, созданных событием.

Параметры

sender

Object

Источник события.

e

TEventArgs

Объект, содержащий данные события.

Атрибуты

SerializableAttribute

Примеры

В следующем примере показано событие с именем ThresholdReached. Событие связано с делегатом 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

Комментарии

Модель событий в .NET основана на наличии делегата события, который подключает событие к обработчику. Для создания события требуются два элемента:

• Делегат, ссылающийся на метод, предоставляющий ответ на событие.
• При необходимости класс, содержащий данные события, если событие предоставляет данные.

Делегат — это тип, определяющий подпись, то есть возвращаемый тип значения и типы списков параметров для метода. Тип делегата можно использовать для объявления переменной, которая может ссылаться на любой метод с той же подписью, что и делегат.

Стандартная сигнатура делегата обработчика событий определяет метод, который не возвращает значение. Первый параметр этого метода имеет тип Object и ссылается на экземпляр, который вызывает событие. Второй параметр является производным от типа EventArgs и содержит данные события. Если событие не создает данные о событиях, второй параметр — это просто значение EventArgs.Empty поля. В противном случае второй параметр является типом, производным от EventArgs всех полей или свойств, необходимых для хранения данных события.

Делегат EventHandler<TEventArgs> — это предопределенный делегат, представляющий метод обработчика событий для события, создающего данные. Преимуществом использования EventHandler<TEventArgs> является то, что вам не нужно кодировать собственный настраиваемый делегат, если событие создает данные о событиях. Вы просто предоставляете тип объекта данных события в качестве универсального параметра.

Чтобы связать событие с методом, который будет обрабатывать событие, добавьте экземпляр делегата в событие. Обработчик событий вызывается всякий раз, когда происходит событие, если вы не удалите делегат.

Дополнительные сведения о делегатах обработчика событий см. в разделе "Обработка и создание событий".

Методы расширения

Имя	Описание
GetMethodInfo(Delegate)	Возвращает объект, представляющий метод, представленный указанным делегатом.

См. также раздел

• EventHandler
• EventArgs
• Delegate
• Обработка и создание событий
• Практическое руководство. Создание и использование событий
• События (Visual Basic)
• События (Руководство по программированию на C#)
• События (F#)