Storyboard.Begin Method (FrameworkContentElement, HandoffBehavior, Boolean) (System.Windows.Media.Animation)

.NET Framework Class Library

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)

Syntax

Visual Basic (Declaration)

Public Sub Begin ( _
    containingObject As FrameworkContentElement, _
    handoffBehavior As HandoffBehavior, _
    isControllable As Boolean _
)

Visual Basic (Usage)

Dim instance As Storyboard
Dim containingObject As FrameworkContentElement
Dim handoffBehavior As HandoffBehavior
Dim isControllable As Boolean

instance.Begin(containingObject, handoffBehavior, _
    isControllable)

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

Visual C++

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

JScript

public function Begin(
    containingObject : FrameworkContentElement, 
    handoffBehavior : HandoffBehavior, 
    isControllable : boolean
)

XAML

You cannot use methods in XAML.

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.

Remarks

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.

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.

To remove all clocks from a property, use the ApplyAnimationClock(DependencyProperty, AnimationClock) or BeginAnimation(DependencyProperty, AnimationTimeline) method of the animated object. Specify the property being animated as the first parameter, and nullNothingnullptra null reference (Nothing in Visual Basic) as the second. This removes all animation clocks from the property.
To remove a specific AnimationClock from a list of clocks, use the Controller property of the AnimationClock to retrieve a ClockController, then call the Remove method of the ClockController. This is typically done in the Completed event handler for a clock. Note that only root clocks can be controlled by a ClockController; the Controller property of a child clock returns nullNothingnullptra null reference (Nothing in Visual Basic). Note also that the Completed event is not called if the effective duration of the clock is forever. In that case, the user must determine when to call Remove.

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.

Examples

The following example uses a controllable storyboard to animate a TextEffect. The TextEffect is contained within a FrameworkContentElement's name scope.

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

Platforms

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.

Version Information

.NET Framework

Supported in: 3.5, 3.0

Reference

Storyboard Class

Storyboard Members

Begin Overload

System.Windows.Media.Animation Namespace