This documentation is archived and is not being maintained.

Storyboard.SetSpeedRatio Method (Double)

Sets the interactive speed ratio for the Clock that was created for this Storyboard.

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

public void SetSpeedRatio(
	double speedRatio
)

Parameters

speedRatio
Type: System.Double
A finite value greater than zero that is the new interactive speed ratio of the storyboard. This value is multiplied against the storyboard's SpeedRatio value to determine the storyboard's effective speed. This value does not overwrite the storyboard's SpeedRatio property. For example, calling this method and specifying an interactive speed ratio of 3 on a storyboard with a SpeedRatio of 0.5 gives the storyboard an effective speed of 1.5.

A controllable storyboard can pause, resume, seek, stop, and be removed. 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.

.NET Framework

Supported in: 4, 3.5 SP1, 3.0 SP2

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: