Simple custom C# event handler

The event model in C# is based on idea of publisher and subscribers. Each publisher can have more subscribers subscribed to each event. Publisher will do some logic and publish an event to all subscribers. Subscribers will do their logic reacting to raised event.

In C#, any object can publish a set of events to which other applications can subscribe. When the publishing class raises an event, all the subscribed applications are notified. Example of this behaviour can be that the application will subscribe to event which will be raised from database connection control when the connection is lost. Main application will know, that this happened and can react on that event –reconnect, show alert message, etc.

Conventions

The following important conventions are used with events:

• Event Handlers in the .NET Framework return void and take two parameters.
• The first paramter is the source of the event; that is the publishing object.
• The second parameter is an object derived from EventArgs.
• Events are properties of the class publishing the event.
• The keyword event controls how the event property is accessed by the subscribing classes.

Example

Lets say that we have Product class which has Name property. When the name is changed we want ot change this name in Label as well. We don’t know from where this name can be changed. We will “convert” product class into event publisher and the window where is the label will subscribe to this event.

First step will be to create the event and method which will fire this event.

public class Product {   public string Name { get; set; }   // Delegate   public delegate void PropertyChangeHandler (object sender,  EventArgs data);   // The event   public event PropertyChangeHandler PropertyChange;   // The method which fires the Event   protected void OnPropertyChange (object sender,  EventArgs data)   {     // Check if there are any Subscribers     if (PropertyChange != null)     {       // Call the Event       PropertyChange (this, data);     }   } }

We created delegate which encapsulates any method that takes these attributes, this delegate must be implemented by all subscribers. Now we need one small change to the class. That will be to fire the event, when Name property is changed. It can be nice to pass information about this change to subscribers with what have been changed and to have old value and new value. For this we will create PropertyChangeEventArgs class which will be derived from EventArgs.

public class PropertyChangeEventArgs : EventArgs {   public string PropertyName { get; internal set; }   public object OldValue { get; internal set; }   public object NewValue { get; internal set; }   public PropertyChangeEventArgs(string propertyName, object oldValue, object newValue)   {     this.PropertyName = propertyName;     this.OldValue = oldValue;     this.NewValue = newValue;   } }   public class Product {   private string name;   public string Name {     get     {       this.name;     }     set     {       // Raise the event only when the property was really changed (thx Kimleng)       if(this.Name != value)       {         Object old = this.name;         this.name = value;         OnPropertyChange(this, new PropertyChangeEventArgs(“Name”, old, value));       }     }   }     // Delegate   public delegate void PropertyChangeHandler (object sender,  PropertyChangeEventArgs data);   // The event   public event PropertyChangeHandler PropertyChange;   // The method which fires the Event   protected void OnPropertyChange (object sender,  PropertyChangeEventArgs data)   {     // Check if there are any Subscribers     if (PropertyChange != null)     {       // Call the Event       PropertyChange (this, data);     }   } }

Now we are done with the Product class (publisher) and can subscribe to the OnPropertyChange event.

protected void Page_Init(object sender, EventArgs e) {   this.Product = new Product();   this.Product.OnPropertyChange += new Product.PropertyChangeHandler(PropertyHasChanged); } protected void Page_Load (object sender, EventArgs e) {   this.Product.Name = "New name"; }   public void PropertyHasChanged (object sender,  PropertyChangeEventArgs data) {   if(data.PropertyName == “Name”)   {     this.ProductLabel.Text = (string)data.NewValue + " was " + (string)data.OldValue;   } }

In the Init event we created product instance and subscribe to OnPropertyChange event of Product class. In Load phase we changed name of that product. This operation fired PropertyChange and this was send to all subscribers. This calls PropertyHasChanged method with all informations.