Storyboard::Begin Method (FrameworkElement, Boolean)
Applies the animations associated with this Storyboard to their targets and initiates them.
Assembly: PresentationFramework (in PresentationFramework.dll)
- Type: System.Windows::FrameworkElement
An object contained within the same name scope as the targets of this storyboard's animations. Animations without a TargetName are applied to containingObject.
- 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 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.
This example shows how to use code to control a Storyboard after it has started. To control a storyboard in XAML, use Trigger and TriggerAction objects; for an example, see How to: Use Event Triggers to Control a Storyboard After It Starts.
To start a storyboard, you use its Begin method, which distributes the storyboard's animations to the properties they animate and starts the storyboard.
To make a storyboard controllable, you use the Begin method and specify true as the second parameter. You can then use the storyboard's interactive methods to pause, resume, seek, stop, speed up, or slow down the storyboard, or advance it to its fill period. The following is a list of the storyboard's interactive methods:
Pause: Pauses the storyboard.
Resume: Resumes a paused storyboard.
SetSpeedRatio: Sets the storyboard's interactive speed.
Seek: Seeks the storyboard the specified location.
SkipToFill: Advances the storyboard to its fill period, if it has one.
Stop: Stops the storyboard.
In the following example, several storyboard methods are used to interactively control a storyboard.
Note: To see an example of controlling a storyboard using triggers with XAML, see How to: Use Event Triggers to Control a Storyboard After It Starts.