This documentation is archived and is not being maintained.

EventSetter Class

Represents an event setter in a style. Event setters invoke the specified event handlers in response to events.

Namespace:  System.Windows
Assembly:  PresentationFramework (in PresentationFramework.dll)

public class EventSetter : SetterBase
<EventSetter .../>

The EventSetter type exposes the following members.

Public methodEventSetter()Initializes a new instance of the EventSetter class.
Public methodEventSetter(RoutedEvent, Delegate)Initializes a new instance of the EventSetter class, using the provided event and handler parameters.

Public propertyEventGets or sets the particular routed event that this EventSetter responds to.
Public propertyHandledEventsTooGets or sets a value that determines whether the handler assigned to the setter should still be invoked, even if the event is marked handled in its event data.
Public propertyHandlerGets or sets the reference to a handler for a routed event in the setter.
Public propertyIsSealedGets a value that indicates whether this object is in an immutable state. (Inherited from SetterBase.)

Protected methodCheckSealedChecks whether this object is read-only and cannot be changed. (Inherited from SetterBase.)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

Event setters invoke the specified event handlers in response to routed events, which apply to all elements that reference the Style rather than requiring you to attach instance handlers to each individual element. Only Style.Setters support EventSetter objects.

You can only declare event setters for events that are routed events. You can declare event setters for routed events with a direct routing strategy, bubbling events, or tunneling events.

Instances of the EventSetter class are usually created through Extensible Application Markup Language (XAML), as an object element within a style defined through XAML. An EventSetter might also be instantiated from code.

Event setters cannot be used in a style that is contained in a theme resource dictionary. This is because a theme resource dictionary at run time is often loose binary XAML (BAML) files, and does not have any scope defined where accompanying code-behind that defines the handlers can exist.

Handlers attached through event setters are invoked after any class handlers for an event, and also after any instance handlers. As a result, if a class handler or instance handler marks an event handled in its arguments, then the handler declared by an event setter is not invoked, unless the event setter specifically sets HandledEventsToo true.

Event setters may also come from BasedOn styles. The event setter handlers from the style specified as BasedOn will be invoked after the handlers on the immediate style.

Note that only Style.Setters supports EventSetter objects. Triggers (TriggerBase and derived classes) do not support EventSetter.

The following example establishes a single EventSetter within a page-level style.

    <Style TargetType="{x:Type Button}">
      <EventSetter Event="Click" Handler="b1SetColor"/>
  <Button>Click me</Button>
  <Button Name="ThisButton" Click="HandleThis">
    Raise event, handle it, use handled=true handler to get it anyway.

The following shows the example event handlers:

void b1SetColor(object sender, RoutedEventArgs e)
  Button b = e.Source as Button;
  b.Background = new SolidColorBrush(Colors.Azure);

void HandleThis(object sender, RoutedEventArgs e)

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.