• Article

BeginStoryboard Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

A trigger action that begins a Storyboard and distributes its animations to their targeted objects and properties.

Inheritance Hierarchy

System.Object
  System.Windows.DependencyObject
    System.Windows.TriggerAction
      System.Windows.Media.Animation.BeginStoryboard

Namespace:  System.Windows.Media.Animation
Assembly:  System.Windows (in System.Windows.dll)

Syntax

'Declaration
<ContentPropertyAttribute("Storyboard", True)> _
Public NotInheritable Class BeginStoryboard _
    Inherits TriggerAction

[ContentPropertyAttribute("Storyboard", true)]
public sealed class BeginStoryboard : TriggerAction

<BeginStoryboard ...>
  singleStoryboard
</BeginStoryboard>

XAML Values

  • singleStoryboard
    A single Storyboard, object element.

The BeginStoryboard type exposes the following members.

Constructors

  Name Description
Public methodSupported by Silverlight for Windows Phone BeginStoryboard Initializes a new instance of the BeginStoryboard class.

Top

Properties

  Name Description
Public propertySupported by Silverlight for Windows Phone Dispatcher Gets the Dispatcher this object is associated with. (Inherited from DependencyObject.)
Public propertySupported by Silverlight for Windows Phone Storyboard Gets or sets the Storyboard that this BeginStoryboard starts.

Top

Methods

  Name Description
Public methodSupported by Silverlight for Windows Phone CheckAccess Determines whether the calling thread has access to this object. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows Phone ClearValue Clears the local value of a dependency property. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows Phone Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows Phone Finalize Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodSupported by Silverlight for Windows Phone GetAnimationBaseValue Returns any base value established for a Silverlight dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows Phone GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public methodSupported by Silverlight for Windows Phone GetType Gets the Type of the current instance. (Inherited from Object.)
Public methodSupported by Silverlight for Windows Phone GetValue Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
Protected methodSupported by Silverlight for Windows Phone MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by Silverlight for Windows Phone ReadLocalValue Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows Phone SetValue Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows Phone ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Fields

  Name Description
Public fieldStatic memberSupported by Silverlight for Windows Phone StoryboardProperty Identifies the Storyboard dependency property.

Top

Remarks

Triggers have only limited support in Silverlight. For more information, see Triggers.

BeginStoryboard is used as a wrapper around a Storyboard that is being triggered. A BeginStoryboard can only contain one Storyboard, not a collection of them.

In addition to starting a storyboard automatically when an object loads, you can use the interactive methods of the Storyboard object to start, pause, resume, and stop an animation. For more information, see Animation Overview.

The XAML syntax for BeginStoryboard and its Storyboard property is an example of XAML content property syntax. For more information on XAML content property syntax, see XAML Overview.

Examples

The following example shows how to use a Storyboard and a BeginStoryboard to make a rectangle that fades in and out of view after it is loaded.

Run this sample

<Canvas>
    <Rectangle
        x:Name="MyAnimatedRectangle"
        Width="100"
        Height="100"
        Fill="Blue">
        <Rectangle.Triggers>

            <!-- Animates the rectangle's opacity. -->
            <EventTrigger
                RoutedEvent="Rectangle.Loaded">
                <BeginStoryboard>
                    <Storyboard>
                        <DoubleAnimation
                            Storyboard.TargetName="MyAnimatedRectangle"
                            Storyboard.TargetProperty="Opacity"
                            From="1.0"
                            To="0.0"
                            Duration="0:0:5"
                            AutoReverse="True"
                            RepeatBehavior="Forever" />
                    </Storyboard>
                </BeginStoryboard>
            </EventTrigger>
        </Rectangle.Triggers>
    </Rectangle>
</Canvas>

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Thread Safety

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