A .Net event actually consists of a pair of accessor methods named add_EventName and remove_EventName. These functions each take a handler delegate, and are expected to add or remove that delegate from the list of event handlers.
In C#, writing public event EventHandler EventName; creates a field-like event. The compiler will automatically generate a private backing field (also a delegate), along with thread-safe accessor methods that add and remove handlers from the backing field (like an auto-implemented property). Within the class that declared the event, EventName refers to this private backing field. Thus, writing EventName(...) in the class calls this field and raises the event (if no handlers have been added, the field will be null).
You can also write custom event accessors to gain full control over how handlers are added to your events. For example, this event will store and trigger handlers in reverse order:
void Main()
{
ReversedEvent += delegate { Console.WriteLine(1); };
ReversedEvent += delegate { Console.WriteLine(2); };
ReversedEvent += delegate { Console.WriteLine(3); };
OnReversedEvent();
}
protected void OnReversedEvent() {
if (reversedEvent != null)
reversedEvent(this, EventArgs.Empty);
}
private EventHandler reversedEvent;
public event EventHandler ReversedEvent {
add {
reversedEvent = value + reversedEvent;
}
remove {
reversedEvent -= value;
}
}
This add accessor uses the non-commutative delegate addition operator to prepend each new handler to the delegate field containing the existing handlers. The raiser method simply calls the combined delegate in the private field. (which is null if there aren’t any handlers)
Note that this code is not thread-safe. If two threads add a handler at the same time, both of them will read the original storage field, add their respective handlers to create a new delegate instance, then write this new delegate back to the field. The thread that writes back to the field last will overwrite the changes made by the other thread, since it never saw the other thread’s handler (this is the same reason that x += y is not thread-safe). The accessors generated by the compiler are threadsafe, either by using lock(this) (C# 3 or earlier) or a lock-free threadsafe implementation (C# 4). For more details, see this series of blog posts.
This example is rather useless. However, there are better reasons to create custom event accessors. WinForms controls store their events in a special EventHandlerList class to save memory. WPF controls create events using the Routed Event system, and store handlers in special storage in DependencyObject. Custom event accessors can also be used to perform validation or logging.
Other posts
-
A _read-only_ object is an object that does not expose any way to change it....
-
{% assign openTag = '{%' %} [Last time]({% post_url 2013-06-09-writing-about-jekyll-in-jekyll %}), we saw how to...
-
[Jekyll](http://jekyllrb.com) is a very nice system for writing blogs. However, it does have some shortcomings,...
-
The next step in [migrating my blog to Jekyll]({% post_url 2013-05-31-migrating-from-blogger-to-jekyll %}) was to convert...
-
The first step in my migration to Jekyll was to import my old posts into...
-
My new design is powered by Jekyll and LESS (the LESS does as much or...
-
After nearly a year of inactivity, I have finally returned to my blog. I had...
-
{% raw %} If you open an older ASP.Net MVC3 project in Visual Studio 2012,...
-
{% raw %} Last year, Microsoft announced a simple new feature in C# 5: Caller...
-
{% raw %} If you use the ASP.Net MVC 3 [Compare] validation attribute on a...
-
{% raw %} CSRF attacks are one of the many security issues that web developers...
-
{% raw %} What’s wrong with the following code? {% endraw %} {% highlight csharp...
-
{% raw %} One common misconception about web security is that protecting important actions with CAPTCHAs...
-
{% raw %} One of the most useful additions to the .Net 4.0 base class...
-
{% raw %} ASP.Net MVC uses the new (to ASP.Net 3.5) Http*Base wrapper classes (HttpContextBase,...
-
{% raw %} People sometimes wonder why C# 5 needs to add caller info attributes,...
-
{% raw %} UPDATE: Now that the Visual Studio 11 beta has shipped with this...
-
{% raw %} UPDATE: Now that the Visual Studio 11 beta has shipped with this...
-
{% raw %} UPDATE: Now that the Visual Studio 11 beta has shipped with this...
-
{% raw %} One common question about ASP.Net MVC is how to make “default” controller....
-
{% raw %} Update: This bug was fixed in XRegExp 1.5.1. However, as far as...
-
{% raw %} Part 1 is here Some languages have better ways to pass boolean...
-
{% raw %} Have you ever written code like this: {% endraw %} {% highlight...
-
{% raw %} C# is usually touted as a type-safe language. However, it is not...
-
{% raw %} Until now, I've been focusing on only one of the differences between...
-
{% raw %} When working with large .Net applications, it can be useful to find...
-
This post
-
Sometimes, it can be useful to make an extension method specifically for a single block...
-
Unlike WinForms or native Win32 development, WPF provides a rich layout model which allows developers...
-
This is part 5 in a series about state and function pointers; part 1 is...
-
This is part 4 in a series about state and function pointers; part 1 is...
-
.Net supports two kinds of delegates: Open delegates and closed delegates. When you create a...
-
This is part 3 in a series about state and function pointers; part 1 is...
-
This is part 2 in a series about state and function pointers; part 1 is...
-
Most languages – with the unfortunate exception of Java – allow functions to be passed...
-
Many people write ForEach extension methods for MVC WebForms views, which take a sequence and...
-
Razor’s inline helpers allow you to create lambda expression that return markup (as a HelperResult). ...
-
In addition to normal and static helpers, Razor supports inline helpers, (also known as templates),...
-
Razor helpers can be extremely useful, but they are designed to be used only by...
-
The Boot Camp drivers in the latest generation of MacBook Pros now expose more of...
-
We’ll continue our trek into Razor’s class-level features with helpers. Helpers are one of Razor’s...
-
After looking at how Razor’s Execute() method is generated, we will turn to class-level features....
-
Last time, we saw how basic Razor constructs are translated into C#. We can see...
-
After looking at the various assemblies in the WebPages framework, we will drill into the...
-
Last time, we saw how standalone Razor pages are served. MVC3 maintains the strict separation...
-
Last time, we saw that ASP.Net Web Pages are implemented in two independent assemblies. These...
-
Razor involves two distinct components: The Razor engine and the WebPages framework. The Razor engine,...
-
jQuery makes it very easy to modify a DOM tree. For example, to strip all...
-
Last time, we saw that there are severe limitations in creating ASPX pages which inherit...
-
ASP.Net pages can inherit from custom classes (as long as they inherit System.Web.UI.Page). This can...
-
.Net developers frequently need to build connection strings, especially when connecting to Access or Excel...
-
One of the unique features of ASP.Net WebPages (formerly Razor) is automatic HTML encoding. All...
-
C# 4.0 adds support for optional parameters. The following code prints 4: static void Main()...
-
The new ASP.Net WebPages view engine (formerly Razor) allows you to create reusable parameterized blocks...
-
.Net DataTables can be very useful when writing data-driven applications. However, they have one limitation:...
-
When designing fluent APIs, one issue that comes up is partial type inference. If a...
-
A common chore in developing real-world C# applications is implementing value semantics for equality. This...
-
Last time, we saw that the this parameter to an instance method in a struct...
-
Usually, you cannot pass ref this as a parameter, since this is not a writable...
-
VB.Net’s Nothing keyword is is not the same as C#’s null. MSDN states, “Assigning Nothing...
-
jQuery contains a powerful and flexible animation engine. However, it has some limitations, primarily due...
-
A generic class can specify that its generic parameter must inherit a type. However, there...
-
In part 1, we discussed the simple approach to making a nested iterator. However, we...
-
C# 2.0 introduced a powerful feature called an iterator, a method which returns an IEnumerable<T>...
-
My previous post stretched the limit of simple copy prevention. Beyond this point, it gets...
-
The methods discussed in my previous post are crude and ugly. Most of the time,...
-
Many web developers like to prevent their viewers from copying their text. While I do...