Storyboard::Begin Method (FrameworkContentElement^, HandoffBehavior, Boolean)

 

Applies the animations associated with this Storyboard to their targets and initiates them, using the specified HandoffBehavior.

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

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

Parameters

containingObject
Type: System.Windows::FrameworkContentElement^

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.

If the targeted properties are already animated, they are replaced using the specified handoff behavior.

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.

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 uses a controllable storyboard to animate a TextEffect. The TextEffect is contained within a FrameworkContentElement's name scope.

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
Available since 3.0
Return to top
Show: