BeginStoryboard class

A trigger action that begins a Storyboard. Not commonly used. See Remarks.

Inheritance

Object

  DependencyObject

    TriggerAction

      BeginStoryboard

Syntax

public sealed class BeginStoryboard : TriggerAction

<BeginStoryboard ...>
  singleStoryboard
</BeginStoryboard>

XAML Values

singleStoryboard

A single Storyboard object element.

Attributes

ActivatableAttribute(NTDDI_WIN8)

ContentPropertyAttribute(Name=Storyboard)

MarshalingBehaviorAttribute(Agile)

StaticAttribute(Windows.UI.Xaml.Media.Animation.IBeginStoryboardStatics, NTDDI_WIN8)

ThreadingAttribute(Both)

VersionAttribute(NTDDI_WIN8)

WebHostHiddenAttribute()

Members

The BeginStoryboard class has these types of members:

• Constructors
• Methods
• Properties

Constructors

The BeginStoryboard class has these constructors.

Methods

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

Properties

The BeginStoryboard class has these properties.

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, you should either use visual states, or start animations by writing a Loaded handler that looks up an animation in page-level resources and then calls Begin on the animation's main Storyboard. For more info, see Quickstart: Control templates or Storyboarded animations.

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, you don't set RoutedEvent, and 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 (such as BeginStoryboard.Storyboard) 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

See also

TriggerAction

Triggers

Storyboard

Quickstart: Control templates

Build date: 12/4/2012