PauseStoryboard Class

Definition

A trigger action that pauses a Storyboard.

public ref class PauseStoryboard sealed : System::Windows::Media::Animation::ControllableStoryboardAction
public sealed class PauseStoryboard : System.Windows.Media.Animation.ControllableStoryboardAction
type PauseStoryboard = class
    inherit ControllableStoryboardAction
Public NotInheritable Class PauseStoryboard
Inherits ControllableStoryboardAction
Inheritance

Remarks

Use a PauseStoryboard with an EventTrigger or a Trigger to pause a Storyboard.

PauseStoryboard only affects a Storyboard when it is active (after the Storyboard starts).

To control a Storyboard, the PauseStoryboard must reference the Name of the BeginStoryboard that controls that Storyboard. See How to: Use Event Triggers to Control a Storyboard After It Starts for an example.

Beginning a Paused Animation

When a BeginStoryboard action is triggered after it has been paused, it appears to resume and restart. That's not what actually happens, however: the BeginStoryboard action actually replaces itself with an unpaused version. Each time a BeginStoryboard action is triggered, clock objects are created for its storyboard. These clocks are distributed to the properties they animate. So, when a BeginStoryboard is triggered again, it doesn't restart its clocks, it replaces them with new clocks.

Constructors

PauseStoryboard()

Initializes a new instance of the PauseStoryboard 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)

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)

Applies to

See also