Storyboard.SetSpeedRatio Method (FrameworkElement, Double)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

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

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

public void SetSpeedRatio(
	FrameworkElement containingObject,
	double speedRatio


Type: System.Windows.FrameworkElement

The object specified when the Begin method was called. This object contains the Clock objects that were created for this storyboard and its children.

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.

To interactively control this storyboard, you must use the same containingObject parameter when calling the interactive methods that you used to begin the storyboard. 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.

Calling this method triggers the CurrentGlobalSpeedInvalidated event.

.NET Framework
Available since 3.0
Return to top