Windows Dev Center

The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

Storyboard.Pause Method (FrameworkContentElement)


Pauses the Clock of the specified FrameworkContentElement associated with this Storyboard.

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

public void Pause(
	FrameworkContentElement containingObject


Type: System.Windows.FrameworkContentElement

The object specified when the Begin method was called. This object contains the Clock objects that were created for this storyboard and its children.

This method pauses the storyboard, but has no discernible effect if it is not active or currently paused. As a side effect, all associated children are also paused.

Seeking a paused storyboard does not resume it. The only way to resume a paused storyboard is to use the Resume method. Calling the Begin method again replaces the paused storyboard with a new one, which has the appearance of resuming it.

To interactively control this storyboard, you must use the same containingObject parameter when calling the interactive methods that you used to begin the storyboard. A controllable storyboard can pause, resume, seek, stop, and be removed. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's Begin method and specify true to make it controllable. Fro an example, see How to: Control a Storyboard After It Starts.

Pausing a storyboard's clock triggers the CurrentGlobalSpeedInvalidated event.

When you Begin a storyboard that was paused, it appears to resume and restart. However, that is not what actually happens. The Begin method actually replaces itself with an unpaused version. Each time the Begin method is called, clock objects are created for the storyboard. These clocks are distributed to the properties they animate. So, when the Begin method is called again, it does not restart its clocks; it replaces them with new clocks.

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

.NET Framework
Available since 3.0
Return to top
© 2015 Microsoft