Storyboard::GetCurrentGlobalSpeed Method (FrameworkContentElement^)
Retrieves the CurrentGlobalSpeed of the Clock that was created for this Storyboard.
Assembly: PresentationFramework (in PresentationFramework.dll)
public: Nullable<double> GetCurrentGlobalSpeed( FrameworkContentElement^ containingObject )
Parameters
- containingObject
-
Type:
System.Windows::FrameworkContentElement^
The object specified when the Begin(FrameworkContentElement^, Boolean) method was called. This object contains the Clock objects that were created for this storyboard and its children.
Return Value
Type: System::Nullable<Double>The current global speed, or null if the clock is stopped.
A clock's CurrentGlobalSpeed speed is the rate at which its time is currently progressing, compared to real-world time.
To use this method to retrieve information about a storyboard's clock, the storyboard must be controllable. 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. For an example, see How to: Control a Storyboard After It Starts.
Available since 3.0