Storyboard.Begin Method (FrameworkContentElement, Boolean)

 

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

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

member Begin : 
        containingObject:FrameworkContentElement *
        isControllable:bool -> unit

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 TargetName are applied to containingObject.

isControllable
Type: System.Boolean

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

If the targeted properties are already animated, they are replaced using the SnapshotAndReplace 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.

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.

.NET Framework
Available since 3.0
Return to top
Show: