Storyboard.GetCurrentGlobalSpeed Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Retrieves the CurrentGlobalSpeed of the Clock that was created for this Storyboard.
Overloads
| GetCurrentGlobalSpeed(FrameworkElement) |
Retrieves the CurrentGlobalSpeed of the Clock that was created for this Storyboard. |
| GetCurrentGlobalSpeed(FrameworkContentElement) |
Retrieves the CurrentGlobalSpeed of the Clock that was created for this Storyboard. |
| GetCurrentGlobalSpeed() |
Retrieves the CurrentGlobalSpeed of the Clock that was created for this Storyboard. |
Remarks
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.
GetCurrentGlobalSpeed(FrameworkElement)
Retrieves the CurrentGlobalSpeed of the Clock that was created for this Storyboard.
public:
Nullable<double> GetCurrentGlobalSpeed(System::Windows::FrameworkElement ^ containingObject);public double? GetCurrentGlobalSpeed (System.Windows.FrameworkElement containingObject);member this.GetCurrentGlobalSpeed : System.Windows.FrameworkElement -> Nullable<double>Public Function GetCurrentGlobalSpeed (containingObject As FrameworkElement) As Nullable(Of Double)Parameters
- containingObject
- FrameworkElement
The object specified when the Begin(FrameworkElement, Boolean) method was called. This object contains the Clock objects that were created for this storyboard and its children.
Returns
The current global speed, or null if the clock is stopped.
Remarks
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.
See also
Applies to
GetCurrentGlobalSpeed(FrameworkContentElement)
Retrieves the CurrentGlobalSpeed of the Clock that was created for this Storyboard.
public:
Nullable<double> GetCurrentGlobalSpeed(System::Windows::FrameworkContentElement ^ containingObject);public double? GetCurrentGlobalSpeed (System.Windows.FrameworkContentElement containingObject);member this.GetCurrentGlobalSpeed : System.Windows.FrameworkContentElement -> Nullable<double>Public Function GetCurrentGlobalSpeed (containingObject As FrameworkContentElement) As Nullable(Of Double)Parameters
- containingObject
- 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.
Returns
The current global speed, or null if the clock is stopped.
Remarks
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.
See also
Applies to
GetCurrentGlobalSpeed()
Retrieves the CurrentGlobalSpeed of the Clock that was created for this Storyboard.
public:
double GetCurrentGlobalSpeed();public double GetCurrentGlobalSpeed ();member this.GetCurrentGlobalSpeed : unit -> doublePublic Function GetCurrentGlobalSpeed () As DoubleReturns
The current global speed, or 0 if the clock is stopped.
Applies to
.NET