Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

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
)

Parameters

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.

Beginning a Paused Storyboard

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.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.