Storyboard.Remove Method (FrameworkElement) (System.Windows.Media.Animation)

Remove Method (FrameworkElement)

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

Storyboard..::.Remove Method (FrameworkElement)

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)

Syntax

Visual Basic (Declaration)

Public Sub Remove ( _
    containingObject As FrameworkElement _
)

Visual Basic (Usage)

Dim instance As Storyboard
Dim containingObject As FrameworkElement

instance.Remove(containingObject)

public void Remove(
    FrameworkElement containingObject
)

Visual C++

public:
void Remove(
    FrameworkElement^ containingObject
)

JScript

public function Remove(
    containingObject : FrameworkElement
)

XAML

You cannot use methods in XAML.

Parameters

containingObject: Type: System.Windows..::.FrameworkElement
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.

Remarks

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.

Examples

This example shows how to use code to control a Storyboard after it has started. To control a storyboard in XAML, use Trigger and TriggerAction objects; for an example, see How to: Use Event Triggers to Control a Storyboard After It Starts.

To start a storyboard, you use its Begin method, which distributes the storyboard's animations to the properties they animate and starts the storyboard.

To make a storyboard controllable, you use the Begin method and specify true as the second parameter. You can then use the storyboard's interactive methods to pause, resume, seek, stop, speed up, or slow down the storyboard, or advance it to its fill period. The following is a list of the storyboard's interactive methods:

Pause: Pauses the storyboard.
Resume: Resumes a paused storyboard.
SetSpeedRatio: Sets the storyboard's interactive speed.
Seek: Seeks the storyboard the specified location.
SeekAlignedToLastTick: Seeks the storyboard to the specified location. Unlike the Seek method, this operation is processed before the next tick.
SkipToFill: Advances the storyboard to its fill period, if it has one.
Stop: Stops the storyboard.

In the following example, several storyboard methods are used to interactively control a storyboard.

Note: To see an example of controlling a storyboard using triggers with XAML, see How to: Use Event Triggers to Control a Storyboard After It Starts.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0

Reference

Storyboard Class

Storyboard Members

Remove Overload

System.Windows.Media.Animation Namespace