Begin Method (FrameworkElement, FrameworkTemplate, HandoffBehavior)

Storyboard.Begin Method (FrameworkElement, FrameworkTemplate, HandoffBehavior)


Applies the animations associated with this Storyboard to their targets within the specified template and initiates them.

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

public void Begin(
	FrameworkElement containingObject,
	FrameworkTemplate frameworkTemplate,
	HandoffBehavior handoffBehavior


Type: System.Windows.FrameworkElement

The object to which the specified frameworkTemplate has been applied. Animations without a TargetName are applied to containingObject.

Type: System.Windows.FrameworkTemplate

The template to animate.

Type: System.Windows.Media.Animation.HandoffBehavior

The behavior the new animation should use to interact with any current animations.

When this method is called, Clock objects are created for the storyboard and any timelines it contains. These clocks are stored with containingObject.

Beginning a storyboard triggers the CurrentStateInvalidated and CurrentGlobalSpeedInvalidated events.

When you apply a Storyboard, AnimationTimeline, or AnimationClock to a property 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 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.

.NET Framework
Available since 3.0
Return to top
© 2015 Microsoft