BeginStoryboard Class
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
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)
XMLNS for XAML: Not mapped to an xmlns.
Syntax
<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 | |
|---|---|---|
.gif "Public method") |
BeginStoryboard | Initializes a new instance of the BeginStoryboard class. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
Dispatcher | Gets the Dispatcher this object is associated with. (Inherited from DependencyObject.) |
|
Storyboard | Gets or sets the Storyboard that this BeginStoryboard starts. |
Top
Methods
| Name | Description | |
|---|---|---|
|
CheckAccess | Determines whether the calling thread has access to this object. (Inherited from DependencyObject.) |
|
ClearValue | Clears the local value of a dependency property. (Inherited from DependencyObject.) |
|
Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
.gif "Protected method") |
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.) |
|
GetAnimationBaseValue | Returns any base value established for a Windows Phone dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.) |
|
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
GetValue | Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.) |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
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.) |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Top
Fields
| Name | Description | |
|---|---|---|
.gif "Public field") .gif "Static member") |
StoryboardProperty | Identifies the Storyboard dependency property. |
Top
Remarks
Triggers have only limited support in Windows Phone. 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, seeAnimations, motion, and output for Windows Phone.
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 for Windows Phone 8.
Version Information
Windows Phone OS
Supported in: 8.1, 8.0, 7.1, 7.0
Platforms
Windows Phone
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.