FrameworkContentElement.BeginStoryboard Method (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.

Namespace:  System.Windows
Assembly:  PresentationFramework (in PresentationFramework.dll)

public void BeginStoryboard(
	Storyboard storyboard,
	HandoffBehavior handoffBehavior
)
You cannot use methods in XAML.

Parameters

storyboard
Type: System.Windows.Media.Animation.Storyboard

The storyboard to begin.

handoffBehavior
Type: System.Windows.Media.Animation.HandoffBehavior

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

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:

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.

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft