Loe inglise keeles Redigeeri

Jagamisviis:

event (C# reference)

  • Artikkel

An event is a member that enables an object to trigger notifications. Event users can attach executable code for events by supplying event handlers. The event keyword declares an event. The event is of a delegate type. While an object triggers an event, the event invokes all supplied event handlers. Event handlers are delegate instances added to the event and executed when the event is raised. Event users can add or remove their event handlers on an event.

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 Guidelines.

C# 
public class SampleEventArgs
{
    public SampleEventArgs(string text) { Text = text; }
    public string Text { get; } // 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 in a thread-safe manner using the ?. operator.
        SampleEvent?.Invoke(this, new SampleEventArgs("Hello"));
    }
}

Events are a special kind of multicast delegate that can only be invoked from within the class (or derived classes) 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 and Delegates.

Events can be marked as public, private, protected, internal, protected internal, or private protected. These access modifiers define how users of the class can access the event. For more information, see Access Modifiers.

Keywords and events

The following keywords apply to events.

Keyword Description For more information
static Makes the event available to callers at any time, even if no instance of the class exists. Static Classes and Static Class Members
virtual Allows derived classes to override the event behavior by using the override keyword. Inheritance
sealed Specifies that for derived classes it is no longer virtual.
abstract 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.

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. 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