BeginStoryboard Class

Reference

Definition

Namespace:: System.Windows.Media.Animation

Assembly:: PresentationFramework.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public ref class BeginStoryboard sealed : System::Windows::TriggerAction

[System.Windows.Markup.ContentProperty("Storyboard")]
[System.Windows.Markup.RuntimeNameProperty("Name")]
public sealed class BeginStoryboard : System.Windows.TriggerAction

[<System.Windows.Markup.ContentProperty("Storyboard")>]
[<System.Windows.Markup.RuntimeNameProperty("Name")>]
type BeginStoryboard = class
    inherit TriggerAction

Public NotInheritable Class BeginStoryboard
Inherits TriggerAction

Inheritance: Object

DispatcherObject

DependencyObject

TriggerAction
BeginStoryboard

Attributes: ContentPropertyAttribute RuntimeNamePropertyAttribute

Remarks

Use a BeginStoryboard action with an EventTrigger or a Trigger to apply animations to their target properties and start them. BeginStoryboard begins a Storyboard by calling Begin on its Storyboard reference when triggered.

When you begin a Storyboard on a property that is already being animated by another Storyboard, the HandoffBehavior property of BeginStoryboard determines how the animation proceeds.

Pause, Resume, Stop, or Otherwise Control a Storyboard Interactively

To be able to pause, resume, or otherwise control a Storyboard that was declared in markup interactively, you must set the Name property of its BeginStoryboard. You can then control the Storyboard by using a ControllableStoryboardAction object (such as PauseStoryboard, ResumeStoryboard, or StopStoryboard) to control it by referencing its Name. If the Name of BeginStoryboard is unspecified, the Storyboard cannot be interactively controlled after it is begun. See How to: Use Event Triggers to Control a Storyboard After It Starts for more information.

Note

In code, you may use the interactive methods of the Storyboard class to control a Storyboard that was applied using a BeginStoryboard. As is the case when using ControllableStoryboardAction objects, you must give the BeginStoryboard a name for its Storyboard to be interactively controllable.

Constructors

BeginStoryboard()

Creates a new instance of the BeginStoryboard class.

Fields

StoryboardProperty

Identifies the Storyboard dependency property.

Properties

DependencyObjectType	Gets the DependencyObjectType that wraps the CLR type of this instance. (Inherited from DependencyObject)
Dispatcher	Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject)
HandoffBehavior	Gets or sets the proper hand-off behavior to start an animation clock in this storyboard.
IsSealed	Gets a value that indicates whether this instance is currently sealed (read-only). (Inherited from DependencyObject)
Name	Gets or sets the name of the BeginStoryboard object. By naming the BeginStoryboard object, the Storyboard can be controlled after it is started.
Storyboard	Gets or sets the Storyboard that this BeginStoryboard starts.

Methods

CheckAccess()	Determines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject)
ClearValue(DependencyProperty)	Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject)
ClearValue(DependencyPropertyKey)	Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject)
CoerceValue(DependencyProperty)	Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject. (Inherited from DependencyObject)
Equals(Object)	Determines whether a provided DependencyObject is equivalent to the current DependencyObject. (Inherited from DependencyObject)
GetHashCode()	Gets a hash code for this DependencyObject. (Inherited from DependencyObject)
GetLocalValueEnumerator()	Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject)
GetType()	Gets the Type of the current instance. (Inherited from Object)
GetValue(DependencyProperty)	Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject)
InvalidateProperty(DependencyProperty)	Re-evaluates the effective value for the specified dependency property. (Inherited from DependencyObject)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnPropertyChanged(DependencyPropertyChangedEventArgs)	Invoked whenever the effective value of any dependency property on this DependencyObject has been updated. The specific dependency property that changed is reported in the event data. (Inherited from DependencyObject)
ReadLocalValue(DependencyProperty)	Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject)
SetCurrentValue(DependencyProperty, Object)	Sets the value of a dependency property without changing its value source. (Inherited from DependencyObject)
SetValue(DependencyProperty, Object)	Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject)
SetValue(DependencyPropertyKey, Object)	Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject)
ShouldSerializeProperty(DependencyProperty)	Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property. (Inherited from DependencyObject)
ToString()	Returns a string that represents the current object. (Inherited from Object)
VerifyAccess()	Enforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject)

Applies to

Jaa