FrameworkContentElement.BeginStoryboard Method

Definition

Namespace:

System.Windows

Assembly:

PresentationFramework.dll

Begins the sequence of actions that are contained in the provided storyboard.

Overloads

BeginStoryboard(Storyboard)	Begins the sequence of actions that are contained in the provided storyboard.
BeginStoryboard(Storyboard, HandoffBehavior)	Begins the sequence of actions that are contained in the provided storyboard, with options specified for what should occur if the property is already animated.
BeginStoryboard(Storyboard, HandoffBehavior, Boolean)	Begins the sequence of actions that are contained in the provided storyboard, with specified state for control of the animation after it is started.

BeginStoryboard(Storyboard)

Begins the sequence of actions that are contained in the provided storyboard.

public:
 void BeginStoryboard(System::Windows::Media::Animation::Storyboard ^ storyboard);

public void BeginStoryboard (System.Windows.Media.Animation.Storyboard storyboard);

member this.BeginStoryboard : System.Windows.Media.Animation.Storyboard -> unit

Public Sub BeginStoryboard (storyboard As Storyboard)

Parameters

storyboard

Storyboard

The storyboard to begin.

Remarks

For the signatures that do not use the isControllable, parameter, or when that parameter is specified false, the timeline clocks associated with the animation are removed as soon as it reaches the "Fill" period. Therefore the animation cannot be restarted after being run once. Note that controlling an animation also requires that the storyboard be named or accessible as an instance in code.

BeginStoryboard(Storyboard, HandoffBehavior)

Begins the sequence of actions that are contained in the provided storyboard, with options specified for what should occur if the property is already animated.

public:
 void BeginStoryboard(System::Windows::Media::Animation::Storyboard ^ storyboard, System::Windows::Media::Animation::HandoffBehavior handoffBehavior);

public void BeginStoryboard (System.Windows.Media.Animation.Storyboard storyboard, System.Windows.Media.Animation.HandoffBehavior handoffBehavior);

member this.BeginStoryboard : System.Windows.Media.Animation.Storyboard * System.Windows.Media.Animation.HandoffBehavior -> unit

Public Sub BeginStoryboard (storyboard As Storyboard, handoffBehavior As HandoffBehavior)

Parameters

storyboard

Storyboard

The storyboard to begin.

handoffBehavior

HandoffBehavior

A value of the enumeration that describes behavior to use if a property described in the storyboard is already animated.

Remarks

For the signatures that do not use the isControllable, parameter, or when that parameter is specified false, the timeline clocks associated with the animation are removed as soon as it reaches the "Fill" period. Therefore the animation cannot be restarted after being run once. Note that controlling an animation also requires that the storyboard be named or accessible as an instance in code.

Using the Compose HandoffBehavior

When you apply a Storyboard, AnimationTimeline, or AnimationClock to a property by using the Compose HandoffBehavior, any Clock objects previously associated with that property continue to consume system resources; the timing system does not remove the clocks automatically.

To avoid performance issues when you apply a large number of clocks by using Compose, you should remove composing clocks from the animated property after they complete. There are several ways to remove a clock:

• To remove all clocks from a property, use the ApplyAnimationClock(DependencyProperty, AnimationClock) or BeginAnimation(DependencyProperty, AnimationTimeline) method of the animated object. Specify the property being animated as the first parameter, and null as the second. This removes all animation clocks from the property.

• To remove a specific AnimationClock from a list of clocks, use the Controller property of the AnimationClock to retrieve a ClockController, then call the Remove method of the ClockController. This is typically done in the Completed event handler for a clock. Note that only root clocks can be controlled by a ClockController; the Controller property of a child clock returns null. Note also that the Completed event is not raised if the effective duration of the clock is forever. In that case, the user must determine when to call Remove.

This is primarily an issue for animations on objects that have a long lifetime. When an object is garbage collected, its clocks are also disconnected and garbage collected.

For more information about clock objects, see Animation and Timing System Overview.

BeginStoryboard(Storyboard, HandoffBehavior, Boolean)

Begins the sequence of actions that are contained in the provided storyboard, with specified state for control of the animation after it is started.

public:
 void BeginStoryboard(System::Windows::Media::Animation::Storyboard ^ storyboard, System::Windows::Media::Animation::HandoffBehavior handoffBehavior, bool isControllable);

public void BeginStoryboard (System.Windows.Media.Animation.Storyboard storyboard, System.Windows.Media.Animation.HandoffBehavior handoffBehavior, bool isControllable);

member this.BeginStoryboard : System.Windows.Media.Animation.Storyboard * System.Windows.Media.Animation.HandoffBehavior * bool -> unit

Public Sub BeginStoryboard (storyboard As Storyboard, handoffBehavior As HandoffBehavior, isControllable As Boolean)

Parameters

storyboard

Storyboard

The storyboard to begin.

handoffBehavior

HandoffBehavior

A value of the enumeration that describes behavior to use if a property described in the storyboard is already animated.

isControllable

Boolean

Declares whether the animation is controllable (can be paused) after it is started.

Remarks

For the signatures that do not use the isControllable, parameter, or when that parameter is specified false, the timeline clocks associated with the animation are removed as soon as it reaches the "Fill" period. Therefore the animation cannot be restarted after being run once. Note that controlling an animation also requires that the storyboard be named or accessible as an instance in code.

Using the Compose HandoffBehavior

When you apply a Storyboard, AnimationTimeline, or AnimationClock to a property by using the Compose HandoffBehavior, any Clock objects previously associated with that property continue to consume system resources; the timing system does not remove these clocks automatically.

To avoid performance issues when you apply a large number of clocks by using Compose, you should remove composing clocks from the animated property after they complete. There are several ways to remove a clock:

• To remove all clocks from a property, use the ApplyAnimationClock(DependencyProperty, AnimationClock) or BeginAnimation(DependencyProperty, AnimationTimeline) method of the animated object. Specify the property being animated as the first parameter, and null as the second. This removes all animation clocks from the property.

• To remove a specific AnimationClock from a list of clocks, use the Controller property of the AnimationClock to retrieve a ClockController, then call the Remove method of the ClockController. This is typically done in the Completed event handler for a clock. Note that only root clocks can be controlled by a ClockController; the Controller property of a child clock returns null. Note also that the Completed event is not raised if the effective duration of the clock is forever. In that case, the user must determine when to call Remove.

This is primarily an issue for animations on objects that have a long lifetime. When an object is garbage collected, its clocks are also disconnected and garbage collected.

For more information about clock objects, see Animation and Timing System Overview.