EventTrigger class

Applies to Windows and Windows Phone

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

Inheritance

Object
  DependencyObject
    TriggerBase
      EventTrigger

Syntax


public sealed class EventTrigger : TriggerBase


<EventTrigger>
  oneOrMoreBeginStoryboards
</EventTrigger>
 

XAML Values

oneOrMoreBeginStoryboards

One or more BeginStoryboard object elements. Object elements defined here become members of the list that is the value of the Actions property, if you use code to examine that collection at run time.

Attributes

[ContentProperty("Name=Actions")]
[MarshalingBehavior(Agile)]
[Threading(Both)]
[Version(0x06020000)]
[WebHostHidden()]

Members

The EventTrigger class has these types of members:

Constructors

The EventTrigger class has these constructors.

ConstructorDescription
EventTrigger Initializes a new instance of the EventTrigger class.

 

Methods

The EventTrigger class has these methods. It also inherits methods from the Object class.

MethodDescription
ClearValue Clears the local value of a dependency property. (Inherited from DependencyObject)
GetAnimationBaseValue Returns any base value established for a dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject)
GetValue Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject)
ReadLocalValue Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject)
SetValue Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject)

 

Properties

The EventTrigger class has these properties.

PropertyAccess typeDescription

Actions

Read-onlyGets the collection of BeginStoryboard objects that this EventTrigger maintains.

Dispatcher

Read-onlyGets the CoreDispatcher that this object is associated with. (Inherited from DependencyObject)

RoutedEvent

Read/writeGets or sets the name of the event that initiates the trigger.

 

Remarks

Triggers, EventTrigger, Actions and BeginStoryboard are not commonly used. These APIs 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>. For more info, see Triggers.

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>

Requirements

Minimum supported client

Windows 8 [Windows Store apps only]

Minimum supported server

Windows Server 2012 [Windows Store apps only]

Minimum supported phone

Windows Phone 8.1 [Windows Runtime apps only]

Namespace

Windows.UI.Xaml
Windows::UI::Xaml [C++]

Metadata

Windows.winmd

See also

TriggerBase
Triggers
Storyboarded animations for visual states
Quickstart: Control templates

 

 

Show:
© 2014 Microsoft