Clock.CurrentProgress Property

Reference

Definition

Namespace:: System.Windows.Media.Animation

Assembly:: PresentationCore.dll

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.

Gets the current progress of this Clock within its current iteration.

public:
 property Nullable<double> CurrentProgress { Nullable<double> get(); };

public double? CurrentProgress { get; }

member this.CurrentProgress : Nullable<double>

Public ReadOnly Property CurrentProgress As Nullable(Of Double)

Property Value

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

The value of this property indicates the CurrentTime normalized by the Duration of this clock's Timeline.

A clock that is Filling has a CurrentProgress of 1.0.

Using a Timeline as a Timer

A timeline's clock will only progress when there's an event handler associated with it or (in the case of an AnimationClock object) it is associated with a property. For this reason (and others), it's not recommended that you use a Timeline as a timer.

Applies to

Product	Versions
.NET Framework	3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop	3.0, 3.1, 5, 6, 7, 8, 9, 10

Share via