This documentation is archived and is not being maintained.

Storyboard.Remove Method (FrameworkContentElement)

Removes the Clock objects that were created for this Storyboard. Animations that belong to this Storyboard no longer affect the properties they once animated, regardless of their FillBehavior setting.

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

public void Remove(
	FrameworkContentElement containingObject
)

Parameters

containingObject
Type: System.Windows.FrameworkContentElement
The object specified when the Storyboard.Begin method was called. This object contains the Clock objects that were created for this storyboard and its children.

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.

Removing a storyboard's clock triggers the RemoveRequested event.

.NET Framework

Supported in: 4, 3.5, 3.0

.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: