Storyboard.GetCurrentProgress 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 CurrentProgress of the Clock that was created for this Storyboard.
Overloads
| GetCurrentProgress() |
Retrieves the CurrentProgress of the Clock that was created for this Storyboard. |
| GetCurrentProgress(FrameworkContentElement) |
Retrieves the CurrentProgress of the Clock that was created for this Storyboard. |
| GetCurrentProgress(FrameworkElement) |
Retrieves the CurrentProgress of the Clock that was created for this Storyboard. |
GetCurrentProgress()
Retrieves the CurrentProgress of the Clock that was created for this Storyboard.
public:
double GetCurrentProgress();public double GetCurrentProgress ();member this.GetCurrentProgress : unit -> doublePublic Function GetCurrentProgress () As DoubleReturns
null if this clock is Stopped, or 0.0 if this clock is active and its Timeline has a Duration of Forever; otherwise, a value between 0.0 and 1.0 that indicates the current progress of this clock within its current iteration. A value of 0.0 indicates no progress, and a value of 1.0 indicates that the clock is at the end of its current iteration.
Remarks
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.
Applies to
GetCurrentProgress(FrameworkContentElement)
Retrieves the CurrentProgress of the Clock that was created for this Storyboard.
public:
Nullable<double> GetCurrentProgress(System::Windows::FrameworkContentElement ^ containingObject);public double? GetCurrentProgress (System.Windows.FrameworkContentElement containingObject);member this.GetCurrentProgress : System.Windows.FrameworkContentElement -> Nullable<double>Public Function GetCurrentProgress (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
null if this clock is Stopped, or 0.0 if this clock is active and its Timeline has a Duration of Forever; otherwise, a value between 0.0 and 1.0 that indicates the current progress of this clock within its current iteration. A value of 0.0 indicates no progress, and a value of 1.0 indicates that the clock is at the end of its current iteration.
Remarks
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.
Applies to
GetCurrentProgress(FrameworkElement)
Retrieves the CurrentProgress of the Clock that was created for this Storyboard.
public:
Nullable<double> GetCurrentProgress(System::Windows::FrameworkElement ^ containingObject);public double? GetCurrentProgress (System.Windows.FrameworkElement containingObject);member this.GetCurrentProgress : System.Windows.FrameworkElement -> Nullable<double>Public Function GetCurrentProgress (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
null if this clock is Stopped, or 0.0 if this clock is active and its Timeline has a Duration of Forever; otherwise, a value between 0.0 and 1.0 that indicates the current progress of this clock within its current iteration. A value of 0.0 indicates no progress, and a value of 1.0 indicates that the clock is at the end of its current iteration.
Remarks
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.
