Руководство по программированию на C#. Публикация событий, соответствующих рекомендациям .NET FrameworkHow to publish events that conform to .NET Framework Guidelines (C# Programming Guide)

Следующая процедура показывает, как добавлять события, которые соответствуют стандартному шаблону .NET Framework для классов и структур.The following procedure demonstrates how to add events that follow the standard .NET Framework pattern to your classes and structs. Все события в библиотеке классов .NET Framework основаны на делегате EventHandler, который определен следующим образом:All events in the .NET Framework class library are based on the EventHandler delegate, which is defined as follows:

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

Примечание

В .NET Framework 2.0 представлена универсальная версия этого делегата, EventHandler<TEventArgs>.The .NET Framework 2.0 introduces a generic version of this delegate, EventHandler<TEventArgs>. В следующих примерах демонстрируется использование обеих версий.The following examples show how to use both versions.

Хотя события в определяемых классах могут быть основаны на действительном типе делегата, даже на делегатах, возвращающих значение, обычно рекомендуется основывать события на шаблоне .NET Framework с помощью EventHandler, как показано в следующем примере.Although events in classes that you define can be based on any valid delegate type, even delegates that return a value, it is generally recommended that you base your events on the .NET Framework pattern by using EventHandler, as shown in the following example.

Публикация событий, основанных на шаблоне EventHandlerTo publish events based on the EventHandler pattern

  1. (Пропустите этот шаг и перейдите к шагу 3a, если не нужно отправлять пользовательские данные с определенным событием.) Объявите класс для пользовательских данных в области, видимой для классов Publisher и Subscriber.(Skip this step and go to Step 3a if you do not have to send custom data with your event.) Declare the class for your custom data at a scope that is visible to both your publisher and subscriber classes. Затем добавьте необходимые члены для хранения пользовательских данных о событиях.Then add the required members to hold your custom event data. В этом примере возвращается простая строка.In this example, a simple string is returned.

    public class CustomEventArgs : EventArgs  
    {  
        public CustomEventArgs(string s)  
        {  
            msg = s;  
        }  
        private string msg;  
        public string Message  
        {  
            get { return msg; }  
        }
    }  
    
  2. (Пропустите этот шаг, если используется универсальная версия EventHandler<TEventArgs>.) Объявите делегат в своем классе публикации.(Skip this step if you are using the generic version of EventHandler<TEventArgs> .) Declare a delegate in your publishing class. Присвойте ему имя, которое заканчивается на EventHandler.Give it a name that ends with EventHandler. Второй параметр указывает настраиваемый тип EventArgs.The second parameter specifies your custom EventArgs type.

    public delegate void CustomEventHandler(object sender, CustomEventArgs a);  
    
  3. Объявите событие в своем классе публикации, выполнив одно из следующих действий.Declare the event in your publishing class by using one of the following steps.

    1. Если у вас нет пользовательского класса EventArgs, тип события будет неуниверсальным делегатом EventHandler.If you have no custom EventArgs class, your Event type will be the non-generic EventHandler delegate. Нет необходимости объявлять делегат, так как он уже объявлен в пространстве имен System, которое включается при создании проекта C#.You do not have to declare the delegate because it is already declared in the System namespace that is included when you create your C# project. Добавьте следующий код в класс Publisher.Add the following code to your publisher class.

      public event EventHandler RaiseCustomEvent;  
      
    2. Если вы используете неуниверсальную версию EventHandler и имеется пользовательский класс, производный от EventArgs, объявите событие внутри класса публикации и используйте делегат из шага 2 в качестве типа.If you are using the non-generic version of EventHandler and you have a custom class derived from EventArgs, declare your event inside your publishing class and use your delegate from step 2 as the type.

      public event CustomEventHandler RaiseCustomEvent;  
      
    3. Если используется универсальная версия, пользовательский делегат не требуется.If you are using the generic version, you do not need a custom delegate. Вместо этого в классе публикации укажите тип события как EventHandler<CustomEventArgs>, подставив имя своего класса в угловые скобки.Instead, in your publishing class, you specify your event type as EventHandler<CustomEventArgs>, substituting the name of your own class between the angle brackets.

      public event EventHandler<CustomEventArgs> RaiseCustomEvent;  
      

ПримерExample

В следующем примере показана вышеописанная процедура с использованием пользовательского класса EventArgs и EventHandler<TEventArgs> в качестве типа событий.The following example demonstrates the previous steps by using a custom EventArgs class and EventHandler<TEventArgs> as the event type.

namespace DotNetEvents
{
    using System;
    using System.Collections.Generic;

    // Define a class to hold custom event info
    public class CustomEventArgs : EventArgs
    {
        public CustomEventArgs(string s)
        {
            message = s;
        }
        private string message;

        public string Message
        {
            get { return message; }
            set { message = value; }
        }
    }

    // Class that publishes an event
    class Publisher
    {

        // Declare the event using EventHandler<T>
        public event EventHandler<CustomEventArgs> RaiseCustomEvent;

        public void DoSomething()
        {
            // Write some code that does something useful here
            // then raise the event. You can also raise an event
            // before you execute a block of code.
            OnRaiseCustomEvent(new CustomEventArgs("Did something"));
        }

        // Wrap event invocations inside a protected virtual method
        // to allow derived classes to override the event invocation behavior
        protected virtual void OnRaiseCustomEvent(CustomEventArgs e)
        {
            // Make a temporary copy of the event to avoid possibility of
            // a race condition if the last subscriber unsubscribes
            // immediately after the null check and before the event is raised.
            EventHandler<CustomEventArgs> handler = RaiseCustomEvent;

            // Event will be null if there are no subscribers
            if (handler != null)
            {
                // Format the string to send inside the CustomEventArgs parameter
                e.Message += $" at {DateTime.Now}";

                // Use the () operator to raise the event.
                handler(this, e);
            }
        }
    }

    //Class that subscribes to an event
    class Subscriber
    {
        private string id;
        public Subscriber(string ID, Publisher pub)
        {
            id = ID;
            // Subscribe to the event using C# 2.0 syntax
            pub.RaiseCustomEvent += HandleCustomEvent;
        }

        // Define what actions to take when the event is raised.
        void HandleCustomEvent(object sender, CustomEventArgs e)
        {
            Console.WriteLine(id + " received this message: {0}", e.Message);
        }
    }

    class Program
    {
        static void Main(string[] args)
        {
            Publisher pub = new Publisher();
            Subscriber sub1 = new Subscriber("sub1", pub);
            Subscriber sub2 = new Subscriber("sub2", pub);

            // Call the method that raises the event.
            pub.DoSomething();

            // Keep the console window open
            Console.WriteLine("Press Enter to close this window.");
            Console.ReadLine();
        }
    }
}

См. такжеSee also