Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

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
)
You cannot use methods in XAML.

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.

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.

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
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.