EventTrigger EventTrigger EventTrigger Class

Definition

Represents a trigger that applies a set of actions (animation storyboards) in response to an event. Not commonly used. See Remarks.

public : sealed class EventTrigger : TriggerBase, IEventTrigger
public sealed class EventTrigger : TriggerBase, IEventTrigger
Public NotInheritable Class EventTrigger Inherits TriggerBase Implements IEventTrigger
<EventTrigger>
  oneOrMoreBeginStoryboards
</EventTrigger>
 
Inheritance
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Examples

This XAML example shows the basic structure for using FrameworkElement.Triggers with its default FrameworkElement.Loaded trigger behavior to run a storyboarded animation. This XAML shows the EventTrigger and BeginStoryboard container elements in proper relationship with each using their XAML content property syntax and unnecessary property element tags omitted.

<Canvas Width="200" Height="200" x:Name="animatedcanvas" Background="Red">
    <Canvas.Triggers>
        <EventTrigger>
            <BeginStoryboard>
                <Storyboard x:Name="ColorStoryboard">
                   <!-- Animate the background of the canvas to green over 4 seconds. -->
                    <ColorAnimation Storyboard.TargetName="animatedcanvas"
                      Storyboard.TargetProperty="(Panel.Background).(SolidColorBrush.Color)"
                      To="Green" Duration="0:0:4"/>
                </Storyboard>
            </BeginStoryboard>
        </EventTrigger>
    </Canvas.Triggers>
</Canvas>

Remarks

Triggers, EventTrigger, Actions and BeginStoryboard are not commonly used. These API mainly exist for compatibility in XAML originally used for Microsoft Silverlight. For most scenarios where event triggers were used previously, do one of these:

If you do choose to use Triggers, in Windows Runtime XAML, the default behavior for event triggers and the only event that can be used to invoke an EventTrigger is FrameworkElement.Loaded. Because that's both the default and the only enabled behavior, don't set the RoutedEvent attribute. Just use the XAML <EventTrigger>. If you set RoutedEvent explicitly (not recommended), the only XAML that works is <EventTrigger RoutedEvent="FrameworkElement.Loaded">. Unqualified "Loaded", or any other value, throws a parse exception. For more info, see Triggers.

Constructors

EventTrigger() EventTrigger() EventTrigger()

Initializes a new instance of the EventTrigger class.

public : EventTrigger()
public EventTrigger()
Public Sub New()

Properties

Actions Actions Actions

Gets the collection of BeginStoryboard objects that this EventTrigger maintains.

public : TriggerActionCollection Actions { get; }
public TriggerActionCollection Actions { get; }
Public ReadOnly Property Actions As TriggerActionCollection
<EventTrigger>
  oneOrMoreBeginStoryboards
</EventTrigger>
 
See Also

Dispatcher Dispatcher Dispatcher

Inherited from DependencyObject

RoutedEvent RoutedEvent RoutedEvent

Gets or sets the name of the event that initiates the trigger. Not commonly set, see Remarks.

public : RoutedEvent RoutedEvent { get; set; }
public RoutedEvent RoutedEvent { get; set; }
Public ReadWrite Property RoutedEvent As RoutedEvent
Value
RoutedEvent RoutedEvent RoutedEvent

The name or identifier of the event.

Methods

ClearValue(DependencyProperty) ClearValue(DependencyProperty) ClearValue(DependencyProperty)

Inherited from DependencyObject

GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty)

Inherited from DependencyObject

GetValue(DependencyProperty) GetValue(DependencyProperty) GetValue(DependencyProperty)

Inherited from DependencyObject

ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty)

Inherited from DependencyObject

RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback)

Inherited from DependencyObject

SetValue(DependencyProperty,Object) SetValue(DependencyProperty,Object) SetValue(DependencyProperty,Object)

Inherited from DependencyObject

UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64)

Inherited from DependencyObject

See Also