Storyboard.GetCurrentProgress Method

Definition

Namespace:

System.Windows.Media.Animation

Assembly:

PresentationFramework.dll

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.

C#

public double GetCurrentProgress();

Returns

Double

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.

GetCurrentProgress(FrameworkContentElement)

Retrieves the CurrentProgress of the Clock that was created for this Storyboard.

C#

public double? GetCurrentProgress(System.Windows.FrameworkContentElement containingObject);

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

Nullable<Double>

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.

GetCurrentProgress(FrameworkElement)

Retrieves the CurrentProgress of the Clock that was created for this Storyboard.

C#

public double? GetCurrentProgress(System.Windows.FrameworkElement containingObject);

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

Nullable<Double>

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.