ClockController.SpeedRatio Property

 

Gets or sets the interactive speed of the target Clock.

Namespace:   System.Windows.Media.Animation
Assembly:  PresentationCore (in PresentationCore.dll)

member SpeedRatio : float with get, set

Property Value

Type: System.Double

A finite value greater than zero that describes the interactive speed of the target clock. This value is multiplied against the value of the SpeedRatio of the clock's Timeline. For example, if the timeline's SpeedRatio is 0.5 and the ClockController object's SpeedRatio is 3.0, the timeline moves at 1.5 times normal speed (0.5 * 3.0). The default value is 1.0.

Setting this property has no effect until the next tick. If you set this property and then get its value before the next tick occurs, you'll get the old value. This property will return the new value after the next tick.

Setting this property does not change the value of the underlying timeline's SpeedRatio.

Setting this property triggers the target clock's CurrentGlobalSpeedInvalidated event.

.NET Framework
Available since 3.0
Return to top
Show: