Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

BeginStoryboard Class

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

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)
[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.

  NameDescription
Public methodSupported by Silverlight for Windows PhoneBeginStoryboardInitializes a new instance of the BeginStoryboard class.
Top
  NameDescription
Public propertySupported by Silverlight for Windows PhoneDispatcherGets the Dispatcher this object is associated with. (Inherited from DependencyObject.)
Public propertySupported by Silverlight for Windows PhoneStoryboardGets or sets the Storyboard that this BeginStoryboard starts.
Top
  NameDescription
Public methodSupported by Silverlight for Windows PhoneCheckAccessDetermines whether the calling thread has access to this object. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows PhoneClearValueClears the local value of a dependency property. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows PhoneEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows PhoneFinalizeAllows 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 PhoneGetAnimationBaseValueReturns 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 PhoneGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneGetValueReturns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
Protected methodSupported by Silverlight for Windows PhoneMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneReadLocalValueReturns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows PhoneSetValueSets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows PhoneToStringReturns a string that represents the current object. (Inherited from Object.)
Top
  NameDescription
Public fieldStatic memberSupported by Silverlight for Windows PhoneStoryboardPropertyIdentifies the Storyboard dependency property.
Top

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.

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>


Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

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

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

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.