Практическое руководство. Реализация событий в классе

Статья
08/11/2011

Следующие процедуры описывают реализацию событий в классе. Первая процедура реализует событие, которое не имеет связанных данных; она использует классы System.EventArgs и System.EventHandler для данных события и обработчика делегата события. Вторая процедура реализует событие с пользовательскими данными; она определяет пользовательские классы для данных события и обработчика делегата события.

Примечание
В этом разделе демонстрируется объявление и порождение события в классе.Здесь не рассказывается о том, как определить обработчик событий, получающий это событие.Сведения о получении событий см. в разделах Прием событий и Практическое руководство. Вызов и прием событий.

В этом разделе демонстрируется объявление и порождение события в классе.Здесь не рассказывается о том, как определить обработчик событий, получающий это событие.Сведения о получении событий см. в разделах Прием событий и Практическое руководство. Вызов и прием событий.

Полный пример порождения и обработки событий см. в разделе Практическое руководство. Вызов и прием событий.

Реализация событий без специальных данных

Определите общий элемент события в классе. Задайте тип элемента события делегату System.EventHandler.

Public Class Countdown
    ' ...

    Public Event CountdownCompleted As EventHandler
End Class

public class Countdown 
{
    // ...

    public event EventHandler CountdownCompleted;   
}

Предоставьте защищенный метод в своем классе, который инициирует событие. Присвойте методу имя OnEventName. Создайте событие в методе. Обратите внимание, что в коде на языке C# перед порождением события следует убедиться, не равно ли оно NULL. Это позволяет устранить необходимость в обработке исключения NullReferenceException, порождаемого в случае, когда к порождаемому событию не привязаны обработчики событий. В данном случае эта проверка необходима по той причине, что класс CountDown порождает событие, но не предоставляет обработчик для него.
```
Public Class Countdown
   ' ...

   Public Event CountdownCompleted As EventHandler

   Protected Overridable Sub OnCountdownCompleted(e As EventArgs)
      RaiseEvent CountdownCompleted(Me, e)
   End Sub
End Class
```
```
public class Countdown 
{
    public event EventHandler CountdownCompleted;   

    protected virtual void OnCountdownCompleted(EventArgs e)
    {
        if (CountdownCompleted != null)
            CountdownCompleted(this, e);
    }
}
```

Определите, когда нужно создавать событие в классе. Вызовите On EventName для создания события.

Public Class Countdown
   Dim internalCounter As Integer = 0
    ' ...

   Public Event CountdownCompleted As EventHandler

   Protected Overridable Sub OnCountdownCompleted(e As EventArgs)
      RaiseEvent CountdownCompleted(Me, e)
   End Sub

   Public Sub Decrement()
      internalCounter -= 1
      If internalCounter = 0
         OnCountdownCompleted(New EventArgs())
      End If
   End Sub
End Class

public class Countdown 
{
   int internalCounter = 0;
   // ...

   public event EventHandler CountdownCompleted;   

    protected virtual void OnCountdownCompleted(EventArgs e)
    {
        if (CountdownCompleted != null)
            CountdownCompleted(this, e);
    }

   public void Decrement()
   {
      internalCounter--;
      if (internalCounter == 0)
         OnCountdownCompleted(new EventArgs());
   }
}

Реализация события со специальными данными

Определите класс, который предоставляет данные для события. Задайте классу имя EventName Args, унаследуйте класс от System.EventArgs, и добавьте любые элементы, характерные для события.

Public Class AlarmEventArgs : Inherits EventArgs
   Private nRings As Integer = 0
   Private pressed As Boolean = False
   Private text As String = "The alarm is ringing!"

   ' Constructor.
   Public Sub New(ByVal snoozePressed As Boolean, ByVal nRings As Integer) 
      Me.pressed = snoozePressed
      Me.nRings = nRings
   End Sub

   ' Properties.
   Public Property AlarmText() As String
      Get
         Return Me.text
      End Get
      Set
         Me.text = value
      End Set  
   End Property 

   Public ReadOnly Property NumRings() As Integer
      Get
         Return Me.nRings
      End Get   
   End Property 

   Public ReadOnly Property SnoozePressed() As Boolean
      Get
         Return Me.pressed
      End Get
   End Property
End Class

public class AlarmEventArgs : EventArgs 
{
   private readonly int nRings = 0;
   private readonly bool pressed = false;
   private string text = "The alarm is ringing!";

   // Constructor.
   public AlarmEventArgs(bool snoozePressed, int nRings) 
   {
      this.pressed = snoozePressed;
      this.nRings = nRings;
   }

   // Properties.
   public string AlarmText {  
      get { return text; }
      set { this.text = value; }
   }

   public int NumRings {
      get { return nRings; }
   }

   public bool SnoozePressed {
      get { return pressed; }
   }
}

Объявите делегата для события. Задайте делегату имя EventName EventHandler.

Public Delegate Sub AlarmEventHandler(sender As Object, e As AlarmEventArgs)

public delegate void AlarmEventHandler(object sender, AlarmEventArgs e);

Определите общий элемент события с именем EventName в классе. Задайте тип элемента события как тип делегата событий.
```
Public Class AlarmClock
    ' ...
    Public Event Alarm As AlarmEventHandler

End Class
```
```
public class AlarmClock 
{
    // ...
    public event AlarmEventHandler Alarm;

}
```
Определите защищенный метод в своем классе, который создает событие. Присвойте методу имя OnEventName. Создайте событие в методе. Обратите внимание, что в коде на языке C# перед порождением события следует убедиться, не равно ли оно NULL. Это позволяет устранить необходимость в обработке исключения NullReferenceException, порождаемого в случае, когда к порождаемому событию не привязаны обработчики событий. В данном случае эта проверка необходима по той причине, что класс CountDown порождает событие, но не предоставляет обработчик для него.
```
Public Class AlarmClock

    ' ...
    Public Event Alarm As AlarmEventHandler

    Protected Overridable Sub OnAlarm(e As AlarmEventArgs)
        RaiseEvent Alarm(Me, e)
    End Sub
End Class
```
```
public class AlarmClock 
{
    // ...
    public event AlarmEventHandler Alarm;

    protected virtual void OnAlarm(AlarmEventArgs e)
    {
      if (Alarm != null) 
          Alarm(this, e); 
    }
}
```

Определите, когда нужно создавать событие в классе. Вызовите метод OnEventName для порождения события и передайте характерные для события данные с помощью аргументов EventArgs события EventName.

Public Class AlarmClock

    Public Sub Start
        ' ...
        System.Threading.Thread.Sleep(300)
        Dim e As AlarmEventArgs = New AlarmEventArgs(False, 0)
        OnAlarm(e)
    End Sub

    Public Event Alarm As AlarmEventHandler

    Protected Overridable Sub OnAlarm(e As AlarmEventArgs)
        RaiseEvent Alarm(Me, e)
    End Sub
End Class

public class AlarmClock 
{
    public void Start()
    {
        // ...
        System.Threading.Thread.Sleep(300);
        AlarmEventArgs e = new AlarmEventArgs(false, 0);
        OnAlarm(e);
    }

    public event AlarmEventHandler Alarm;

    protected virtual void OnAlarm(AlarmEventArgs e)
    {
      if (Alarm != null) 
          Alarm(this, e); 
    }
}

Пример

В следующем примере определяется класс DiskSpaceMonitor, использующий событие для подачи предупреждения в случае, если объем свободного дискового пространства становится меньше процентной доли, указанной в файле конфигурации. В нем также определяется класс DiskSpaceWarningEventArgs, предоставляющий пользовательские данные о свободном дисковом пространстве обработчикам событий.

Imports System.Collections.Specialized
Imports System.Configuration
Imports System.IO

Public Class DiskSpaceWarningEventArgs : Inherits EventArgs
   Dim currentFreeSpace As Long
   Dim currentTotalSpace As Long
   Dim driveName As String

   Public Sub New(name As String, freeSpace As Long, totalSpace As Long)
      Me.driveName = name
      Me.currentFreeSpace = freeSpace
      Me.currentTotalSpace = totalSpace
   End Sub

   Public ReadOnly Property Name As String
      Get
         Return Me.driveName
      End Get
   End Property

   Public ReadOnly Property FreeSpace As Long
      Get
         Return Me.currentFreeSpace 
      End Get
   End Property

   Public ReadOnly Property TotalSpace As Long
      Get
         Return Me.currentTotalSpace
      End Get
   End Property
End Class

Public Delegate Sub DiskSpaceWarningEventHandler(sender As Object, _
                                                 e As DiskSpaceWarningEventArgs)

Public Class DiskSpaceMonitor
   Public Event DiskSpaceWarning As DiskSpaceWarningEventHandler
   Private threshhold As Decimal 

   Public Sub New()
      ' Retrieve threshhold to fire event from configuration file.
      Try
         Dim settings As NameValueCollection = ConfigurationManager.AppSettings
         Me.threshhold = CDec(settings.Item("Threshhold"))
      ' If there is no configuration file, provide a default value.
      Catch e As ConfigurationErrorsException
         Me.threshhold = 10d
      Catch e As InvalidCastException
         Me.threshhold = 10d
      End Try               
   End Sub

   Public Sub CheckFreeSpace
      ' Get drives present on system.
      Dim drives() As DriveInfo = DriveInfo.GetDrives()
      For Each drive As DriveInfo In drives
         If drive.IsReady Then
            If drive.TotalFreeSpace/drive.TotalSize <= Me.threshhold Then
               OnDiskSpaceWarning(New DiskSpaceWarningEventArgs(drive.Name, _
                                  drive.TotalFreeSpace, drive.TotalSize))
            End If
         End If
      Next   
   End Sub

   Protected Sub OnDiskSpaceWarning(e As DiskSpaceWarningEventArgs)
      RaiseEvent DiskSpaceWarning(me, e)
   End Sub
End Class

using System;
using System.Collections.Specialized;
using System.Configuration;
using System.IO;

public class DiskSpaceWarningEventArgs : EventArgs
{
   private long currentFreeSpace;
   private long currentTotalSpace;
   private string driveName;

   public DiskSpaceWarningEventArgs(string name, long freeSpace, long totalSpace)
   {
      this.driveName = name;
      this.currentFreeSpace = freeSpace;
      this.currentTotalSpace = totalSpace;
   }

   public string Name
   {
      get { return this.driveName; }
   }

   public long FreeSpace
   {
      get { return this.currentFreeSpace; }
   }

   public long TotalSpace
   {
      get { return this.currentTotalSpace; }
   }
}

public delegate void DiskSpaceWarningEventHandler(object sender, 
                                                  DiskSpaceWarningEventArgs e);

public class DiskSpaceMonitor
{
   public event DiskSpaceWarningEventHandler DiskSpaceWarning;
   private decimal threshhold;

   public DiskSpaceMonitor()
   {
      // Retrieve threshhold to fire event from configuration file.
      try
      {
         NameValueCollection settings = ConfigurationManager.AppSettings;
         this.threshhold = Convert.ToDecimal(settings["Threshhold"]);
      }
      // If there is no configuration file, provide a default value.
      catch (ConfigurationErrorsException)
      {
         this.threshhold = 10m;
      }
      catch (InvalidCastException)
      {
         this.threshhold = 10m;
      }
   }

   public void CheckFreeSpace()
   {
      // Get drives present on system.
      DriveInfo[] drives = DriveInfo.GetDrives();
      foreach (DriveInfo drive in drives)
      {
         if (drive.IsReady)
         {
            if (drive.TotalFreeSpace/drive.TotalSize <= this.threshhold)
               OnDiskSpaceWarning(new DiskSpaceWarningEventArgs(drive.Name, 
                                  drive.TotalFreeSpace, drive.TotalSize));
         }
      }
   }

   protected void OnDiskSpaceWarning(DiskSpaceWarningEventArgs e)
   {
      if (DiskSpaceWarning != null)
         DiskSpaceWarning(this, e);
   }   
}

Вместо класса EventArgs для предоставления данных события в примере используется пользовательский класс данных события с именем DiskSpaceWarningEventArgs. Он предоставляет обработчикам событий имя диска, а также объем общего и свободного дискового пространства на этом диске. В примере также определяется делегат DiskSpaceWarningEventHandler, представляющий сигнатуру события.

В классе DiskSpaceMonitor определяется событие DiskSpaceWarning и предоставляется метод OnDiskSpaceWarning, порождающий это событие. В свою очередь, метод OnDiskSpaceWarning вызывается методом CheckFreeSpace, если выясняется, что доля свободного пространства на диске не превышает процентную долю, определенную в файле конфигурации.

См. также

Поделиться через

Практическое руководство. Реализация событий в классе

Реализация событий без специальных данных

Реализация события со специальными данными

Пример

См. также

Задачи

Основные понятия

Другие ресурсы

Дополнительные ресурсы