Windows Dev Center

Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

Storyboard.Begin Method (FrameworkElement, FrameworkTemplate, HandoffBehavior, Boolean)

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,
	bool isControllable
)

Parameters

containingObject
Type: System.Windows.FrameworkElement

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

frameworkTemplate
Type: System.Windows.FrameworkTemplate

The template to animate.

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

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

isControllable
Type: System.Boolean

true if the storyboard should be interactively controllable; otherwise, false.

To interactively control this storyboard, you must specify the same containingObject when calling the interactive methods that you used to begin the storyboard

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.

Using the Compose HandoffBehavior

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

Supported in: 4.6, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Show:
© 2015 Microsoft