Export (0) Print
Expand All

Storyboard::Begin Method (FrameworkElement, HandoffBehavior, Boolean)

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

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

public:
void Begin(
	FrameworkElement^ containingObject, 
	HandoffBehavior handoffBehavior, 
	bool isControllable
)

Parameters

containingObject
Type: System.Windows::FrameworkElement

An object contained within the same name scope as the targets of this storyboard's animations. Animations without a specified TargetName are applied to containingObject.

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

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

isControllable
Type: System::Boolean

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

To interactively control this storyboard, you must use the same containingObject parameter 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.

The following example shows how to create a controllable storyboard.

No code example is currently available or this language may not be supported.

The next example uses the SnapshotAndReplace HandoffBehavior to animate when the user left-clicks, and the Compose HandoffBehavior when the user right-clicks.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft