EventHandler<TEventArgs> Delegado

Definición

Espacio de nombres:

System

Ensamblado:

System.Runtime.dll

Representa el método que controlará un evento si el evento proporciona datos.

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

public delegate void EventHandler<TEventArgs>(object? sender, TEventArgs e);

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

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

Parámetros de tipo

TEventArgs

Tipo de datos de evento generados por el evento.

Parámetros

sender

Object

Origen del evento.

e

TEventArgs

Objeto que contiene los datos del evento.

Ejemplos

En el ejemplo siguiente se muestra un evento denominado ThresholdReached. El evento está asociado a un EventHandler<TEventArgs> delegado.

using namespace System;

public ref class ThresholdReachedEventArgs : public EventArgs
{
   public:
      property int Threshold;
      property DateTime TimeReached;
};

public ref class Counter
{
   private:
      int threshold;
      int total;

   public:
      Counter() {};

      Counter(int passedThreshold)
      {
         threshold = passedThreshold;
      }

      void Add(int x)
      {
          total += x;
          if (total >= threshold) {
             ThresholdReachedEventArgs^ args = gcnew ThresholdReachedEventArgs();
             args->Threshold = threshold;
             args->TimeReached = DateTime::Now;
             OnThresholdReached(args);
          }
      }

      event EventHandler<ThresholdReachedEventArgs^>^ ThresholdReached;

   protected:
      virtual void OnThresholdReached(ThresholdReachedEventArgs^ e)
      {
         ThresholdReached(this, e);
      }
};

public ref class SampleHandler
{
   public:
      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);
      }
};

void main()
{
   Counter^ c = gcnew Counter((gcnew Random())->Next(10));
   c->ThresholdReached += gcnew EventHandler<ThresholdReachedEventArgs^>(SampleHandler::c_ThresholdReached);

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

using System;

namespace ConsoleApplication1
{
    class Program
    {
        static void Main(string[] args)
        {
            Counter c = new Counter(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 int threshold;
        private int total;

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

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

        protected virtual void OnThresholdReached(ThresholdReachedEventArgs e)
        {
            EventHandler<ThresholdReachedEventArgs> handler = ThresholdReached;
            if (handler != null)
            {
                handler(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

Comentarios

El modelo de eventos de .NET Framework se basa en tener un delegado de eventos que conecta un evento con su controlador. Para generar un evento, se necesitan dos elementos:

• Delegado que hace referencia a un método que proporciona la respuesta al evento.

• Opcionalmente, una clase que contiene los datos del evento, si el evento proporciona datos.

El delegado es un tipo que define una firma, es decir, el tipo de valor devuelto y los tipos de lista de parámetros de un método. Puede usar el tipo de delegado para declarar una variable que pueda hacer referencia a cualquier método con la misma firma que el delegado.

La firma estándar de un delegado de controlador de eventos define un método que no devuelve un valor. El primer parámetro de este método es de tipo Object y hace referencia a la instancia que genera el evento. Su segundo parámetro se deriva del tipo EventArgs y contiene los datos del evento. Si el evento no genera datos de eventos, el segundo parámetro es simplemente el valor del EventArgs.Empty campo. De lo contrario, el segundo parámetro es un tipo derivado de EventArgs y proporciona los campos o propiedades necesarios para contener los datos del evento.

El EventHandler<TEventArgs> delegado es un delegado predefinido que representa un método de controlador de eventos para un evento que genera datos. La ventaja de usar EventHandler<TEventArgs> es que no es necesario codificar su propio delegado personalizado si el evento genera datos de eventos. Simplemente proporcione el tipo del objeto de datos de evento como parámetro genérico.

Para asociar el evento con el método que controlará el evento, agregue una instancia del delegado al evento. Siempre que se produce el evento, se llama a su controlador, a menos que se quite el delegado.

Para obtener más información sobre los delegados del controlador de eventos, vea Control y generación de eventos.

Métodos de extensión

GetMethodInfo(Delegate)

Obtiene un objeto que representa el método representado por el delegado especificado.

Consulte también

• EventHandler
• EventArgs
• Delegate
• Control y generación de eventos
• Cómo: Provocar y utilizar eventos
• Eventos (Visual Basic)
• Eventos (Guía de programación de C#)
• Eventos (F#)
• Introducción a eventos y eventos enrutados (aplicaciones de la Tienda Windows)