RemoveStoryboard Class
Collapse the table of content
Expand the table of content

RemoveStoryboard Class


A trigger action that removes a Storyboard.

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

public sealed class RemoveStoryboard : ControllableStoryboardAction


Initializes a new instance of the RemoveStoryboard class.


Gets or sets the Name of the BeginStoryboard that began the Storyboard you want to interactively control. (Inherited from ControllableStoryboardAction.)


Gets the DependencyObjectType that wraps the CLR type of this instance. (Inherited from DependencyObject.)


Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)


Gets a value that indicates whether this instance is currently sealed (read-only).(Inherited from DependencyObject.)


Determines whether the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)


Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.)


Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.)


Coerces the value of the specified . 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.)GTMT


Determines whether a provided DependencyObject is equivalent to the current DependencyObject.(Inherited from DependencyObject.)


Gets a hash code for this DependencyObject.(Inherited from DependencyObject.)


Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.)


Gets the Type of the current instance.(Inherited from Object.)


Returns the current effective value of a on this instance of a DependencyObject. (Inherited from DependencyObject.)GTMT


Re-evaluates the effective value for the specified dependency property(Inherited from DependencyObject.)


Returns the local value of a , if it exists. (Inherited from DependencyObject.)GTMT

System_CAPS_pubmethodSetCurrentValue(DependencyProperty, Object)

Sets the value of a without changing its value source. (Inherited from DependencyObject.)GTMT

System_CAPS_pubmethodSetValue(DependencyProperty, Object)

Sets the local value of a , specified by its dependency property identifier. (Inherited from DependencyObject.)GTMT

System_CAPS_pubmethodSetValue(DependencyPropertyKey, Object)

Sets the local value of a read-only , specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject.)GTMT


Returns a value that indicates whether serialization processes should serialize the value for the provided .(Inherited from DependencyObject.)GTMT


Returns a string that represents the current object.(Inherited from Object.)


Enforces that the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)

Use RemoveStoryboard with a EventTrigger or Trigger to remove a Storyboard.

To be able to pause, resume, remove, 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.

You should use the RemoveStoryboard action to remove any storyboards begun with a HandoffBehavior of Compose. It's also a good idea to remove background animations when the object they animate is no longer being used. For example, if you apply an indefinitely repeating storyboard using an element's Loaded event, you should also create an EventTrigger that uses a RemoveStoryboard action to remove the storyboard on the element's Unloaded event.

The following example shows how to remove a Storyboard to stop it from continuing when the user navigates away from the page containing the Storyboard.

.NET Framework
Available since 3.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
© 2015 Microsoft