SetStoryboardSpeedRatio Class
Definition
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.
A trigger action that changes the speed of a Storyboard.
public ref class SetStoryboardSpeedRatio sealed : System::Windows::Media::Animation::ControllableStoryboardActionpublic sealed class SetStoryboardSpeedRatio : System.Windows.Media.Animation.ControllableStoryboardActiontype SetStoryboardSpeedRatio = class
inherit ControllableStoryboardActionPublic NotInheritable Class SetStoryboardSpeedRatio
Inherits ControllableStoryboardAction- Inheritance
-
SetStoryboardSpeedRatio
Remarks
Use a SetStoryboardSpeedRatio action with an EventTrigger or a Trigger to interactively control a storyboard's speed ratio.
Use the SpeedRatio property of SetStoryboardSpeedRatio to specify a new Storyboard animation speed as a ratio of the old animation speed. For example, if you set the SpeedRatio to 2, you double the speed of the Storyboard animations and if you set a value of 0.5, you reduce the speed by 50 percent.
This object affects the Storyboard at anytime after the Storyboard begins. For example, if you pause the Storyboard and use the SetStoryboardSpeedRatio, when you resume the Storyboard, it uses the new speed ratio.
PauseStoryboard does not control a Storyboard directly. Rather, PauseStoryboard must reference the Name of the BeginStoryboard, which controls the Storyboard.
Pause, Resume, Stop, or Otherwise Control a Storyboard Interactively
To be able to pause, resume, or otherwise control a Storyboard interactively, set the Name property of its BeginStoryboard and use a ControllableStoryboardAction object (such as PauseStoryboard, ResumeStoryboard, or StopStoryboard) to control it by referencing its Name. If the Name of BeginStoryboard is unspecified, the Storyboard cannot be interactively controlled after it is begun. See How to: Use Event Triggers to Control a Storyboard After It Starts for more information.
Constructors
| SetStoryboardSpeedRatio() |
Initializes a new instance of the SetStoryboardSpeedRatio class. |
Properties
| BeginStoryboardName |
Gets or sets the Name of the BeginStoryboard that began the Storyboard you want to interactively control. (Inherited from ControllableStoryboardAction) |
| DependencyObjectType |
Gets the DependencyObjectType that wraps the CLR type of this instance. (Inherited from DependencyObject) |
| Dispatcher |
Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject) |
| IsSealed |
Gets a value that indicates whether this instance is currently sealed (read-only). (Inherited from DependencyObject) |
| SpeedRatio |
Gets or sets a new Storyboard animation speed as a ratio of the old animation speed. |
Methods
| CheckAccess() |
Determines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject) |
| ClearValue(DependencyProperty) |
Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject) |
| ClearValue(DependencyPropertyKey) |
Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject) |
| CoerceValue(DependencyProperty) |
Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject. (Inherited from DependencyObject) |
| Equals(Object) |
Determines whether a provided DependencyObject is equivalent to the current DependencyObject. (Inherited from DependencyObject) |
| GetHashCode() |
Gets a hash code for this DependencyObject. (Inherited from DependencyObject) |
| GetLocalValueEnumerator() |
Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject) |
| GetType() |
Gets the Type of the current instance. (Inherited from Object) |
| GetValue(DependencyProperty) |
Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject) |
| InvalidateProperty(DependencyProperty) |
Re-evaluates the effective value for the specified dependency property. (Inherited from DependencyObject) |
| MemberwiseClone() |
Creates a shallow copy of the current Object. (Inherited from Object) |
| OnPropertyChanged(DependencyPropertyChangedEventArgs) |
Invoked whenever the effective value of any dependency property on this DependencyObject has been updated. The specific dependency property that changed is reported in the event data. (Inherited from DependencyObject) |
| ReadLocalValue(DependencyProperty) |
Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject) |
| SetCurrentValue(DependencyProperty, Object) |
Sets the value of a dependency property without changing its value source. (Inherited from DependencyObject) |
| SetValue(DependencyProperty, Object) |
Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject) |
| SetValue(DependencyPropertyKey, Object) |
Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject) |
| ShouldSerializeProperty(DependencyProperty) |
Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property. (Inherited from DependencyObject) |
| ToString() |
Returns a string that represents the current object. (Inherited from Object) |
| VerifyAccess() |
Enforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject) |
