Герберт Шилдт - C# 4.0: полное руководство

В C# разрешается формировать какие угодно разновидности событий. Но ради совместимости программных компонентов со средой .NET Framework следует придерживаться рекомендаций, установленных для этой цели корпорацией Microsoft. Эти рекомендации, по существу, сводятся к следующему требованию: у обработчиков событий должны быть два параметра. Первый из них — ссылка на объект, формирующий событие, второй — параметр типа EventArgs, содержащий любую дополнительную информацию о событии, которая требуется обработчику. Таким образом, .NET-совместимые обработчики событий должны иметь следующую общую форму.

void обработчик(object отправитель, EventArgs е) {

// ...

}

Как правило, отправитель — это параметр, передаваемый вызывающим кодом с помощью ключевого слова this. А параметр е типа EventArgsсодержит дополнительную информацию о событии и может быть проигнорирован, если он не нужен.

Сам класс EventArgsне содержит поля, которые могут быть использованы для передачи дополнительных данных обработчику. Напротив, EventArgsслужит в качестве базового класса, от которого получается производный класс, содержащий все необходимые поля. Тем не менее в классе EventArgsимеется одно поле Emptyтипа static, которое представляет собой объект типа EventArgsбез данных.

Ниже приведен пример программы, в которой формируется .NET-совместимое событие.

// Пример формирования .NET-совместимого события,

using System;

// Объявить класс, производный от класса EventArgs.

class MyEventArgs : EventArgs {

public int EventNum;

}

// Объявить тип делегата для события.

delegate void MyEventHandler(object source, MyEventArgs arg);

// Объявить класс, содержащий событие,

class MyEvent {

static int count = 0;

public event MyEventHandler SomeEvent;

// Этот метод запускает событие SomeEvent.

public void OnSomeEvent() {

MyEventArgs arg = new MyEventArgs();

if(SomeEvent != null) {

arg.EventNum = count++;

SomeEvent(this, arg);

}

}

}

class X {

public void Handler(object source, MyEventArgs arg){

Console.WriteLine("Событие " + arg.EventNum +

" получено объектом класса X.");

Console.WriteLine("Источник: " + source);

Console.WriteLine();

}

}

class Y {

public void Handler(object source, MyEventArgs arg){

Console.WriteLine("Событие " + arg.EventNum +

" получено объектом класса Y.");

Console.WriteLine("Источник: " + source);

Console.WriteLine() ;

}

}

class EventDemo6 {

static void Main() {

X ob1 = new X();

Y ob2 = new Y();

MyEvent evt = new MyEvent();

// Добавить обработчик Handler() в цепочку событий,

evt.SomeEvent += ob1. Handler;

evt.SomeEvent += ob2.Handler;

// Запустить событие,

evt.OnSomeEvent();

evt.OnSomeEvent();

}

}

Ниже приведен результат выполнения этой программы.

Событие 0 получено объектом класса X

Источник: MyEvent

Событие 0 получено объектом класса Y

Источник: MyEvent

Событие 1 получено объектом класса X

Источник: MyEvent

Событие 1 получено объектом класса Y

Источник: MyEvent

В данном примере создается класс MyEventArgs, производный от класса EventArgs. В классе MyEventArgsдобавляется лишь одно его собственное поле: EventNum. Затем объявляется делегат MyEventHandler, принимающий два параметра, требующиеся для среды .NET Framework. Как пояснялось выше, первый параметр содержит ссылку на объект, формирующий событие, а второй параметр — ссылку на объект класса EventArgsили производного от него класса. Обработчики событий Handler(), определяемые в классах X и Y, принимают параметры тех же самых типов.

В классе MyEventобъявляется событие SomeEventтипа MyEventHandler. Это событие запускается в методе OnSomeEvent()с помощью делегата SomeEvent, которому в качестве первого аргумента передается ссылка this, а вторым аргументом служит экземпляр объекта типа MyEventArgs. Таким образом, делегату типа MyEventHandlerпередаются надлежащие аргументы в соответствии с требованиями совместимости со средой .NET.

В приведенном выше примере программы объявлялся собственный делегат события. Но как правило, в этом не никакой необходимости, поскольку в среде .NET Framework предоставляется встроенный обобщенный делегат под названием EventHandler. (Более подробно обобщенные типы рассматриваются в главе 18.) В данном случае тип TEventArgsобозначает тип аргумента, передаваемого параметру EventArgsсобытия. Например, в приведенной выше программе событие SomeEventможет быть объявлено в классе MyEventследующим образом.

public event EventHandler SomeEvent;

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

Для обработки многих событий параметр типа EventArgsоказывается ненужным. Поэтому с целью упростить создание кода в подобных ситуациях в среду .NET Framework внедрен необобщенный делегат типа EventHandler. Он может быть использован для объявления обработчиков событий, которым не требуется дополнительная информация о событиях. Ниже приведен пример использования делегата EventHandler.

// Использовать встроенный делегат EventHandler.

using System;

// Объявить класс, содержащий событие,

class MyEvent {

public event EventHandler SomeEvent; // использовать делегат EventHandler

// Этот метод вызывается для запуска события.

public void OnSomeEvent() {

if(SomeEvent != null)

SomeEvent(this, EventArgs.Empty);

}

}

class EventDemo7 {

static void Handler(object source, EventArgs arg) {