event (C# Reference)
The event keyword is used to declare an event in a publisher class.
Example
The following example shows how to declare and raise an event that uses EventHandler as the underlying delegate type. For the complete code example that also shows how to use the generic EventHandler<TEventArgs> delegate type and how to subscribe to an event and create an event handler method, see How to: Publish Events that Conform to .NET Framework Guidelines (C# Programming Guide).
public class SampleEventArgs
{
public SampleEventArgs(string s) { Text = s; }
public String Text {get; private set;} // readonly
}
public class Publisher
{
// Declare the delegate (if using non-generic pattern).
public delegate void SampleEventHandler(object sender, SampleEventArgs e);
// Declare the event.
public event SampleEventHandler SampleEvent;
// Wrap the event in a protected virtual method
// to enable derived classes to raise the event.
protected virtual void RaiseSampleEvent()
{
// Raise the event by using the () operator.
if (SampleEvent != null)
SampleEvent(this, new SampleEventArgs("Hello"));
}
}
Events are a special kind of multicast delegate that can only be invoked from within the class or struct where they are declared (the publisher class). If other classes or structs subscribe to the event, their event handler methods will be called when the publisher class raises the event. For more information and code examples, see Events (C# Programming Guide) and Delegates (C# Programming Guide).
Events can be marked as public, private, protected, internal, or protectedinternal. These access modifiers define how users of the class can access the event. For more information, see Access Modifiers (C# Programming Guide).
Keywords and Events
The following keywords apply to events.
Keyword |
Description |
For more information |
|---|---|---|
Makes the event available to callers at any time, even if no instance of the class exists. |
Static Classes and Static Class Members (C# Programming Guide) |
|
Allows derived classes to override the event behavior by using the override keyword. |
||
Specifies that for derived classes it is no longer virtual. |
|
|
The compiler will not generate the add and remove event accessor blocks and therefore derived classes must provide their own implementation. |
|
An event may be declared as a static event by using the static keyword. This makes the event available to callers at any time, even if no instance of the class exists. For more information, see Static Classes and Static Class Members (C# Programming Guide).
An event can be marked as a virtual event by using the virtual keyword. This enables derived classes to override the event behavior by using the override keyword. For more information, see Inheritance (C# Programming Guide). An event overriding a virtual event can also be sealed, which specifies that for derived classes it is no longer virtual. Lastly, an event can be declared abstract, which means that the compiler will not generate the add and remove event accessor blocks. Therefore derived classes must provide their own implementation.
C# Language Specification
For more information, see the C# Language Specification. The language specification is the definitive source for C# syntax and usage.
See Also
Tasks
How to: Combine Delegates (Multicast Delegates)(C# Programming Guide)