Skip to main content
HandoffBehavior Enumeration
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Specifies how new animations interact with any existing ones that are already applied to a property.

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

public enum HandoffBehavior
public enum class HandoffBehavior
type HandoffBehavior
Public Enumeration HandoffBehavior
Member nameDescription
Compose

New animations are combined with existing animations by appending the new animations to the end of the composition chain.

SnapshotAndReplace

New animations replace any existing animations on the properties to which they are applied.

When you apply a Storyboard, AnimationTimeline, or AnimationClock to a property by using HandoffBehaviorCompose, any Clock objects previously associated with that property continue to consume system resources; the timing system will not remove the clocks automatically.

To avoid performance issues when you apply a large number of clocks using HandoffBehaviorCompose, you should remove composing clocks from the animated property after they complete. There are several ways to remove a clock:

  • To remove all clocks from a property, use the ApplyAnimationClock or BeginAnimation method of the animated object. Specify the property being animated as the first parameter, and null as the second. This will remove all animation clocks from the property.

  • To remove a specific AnimationClock from a list of clocks, use the property of the AnimationClock to retrieve a ClockController, then call the Remove method of the ClockController. This is typically done in the Completed event handler for a clock. Note that only root clocks can be controlled by a ClockController; the property of a child clock returns null. Note also that the Completed event will not be raised if the effective duration of the clock is forever. In that case, the user must determine when to call Remove.

This is primarily an issue for animations on objects that have a long lifetime. When an object is garbage collected, its clocks will also be disconnected and garbage collected.

For more information about clock objects, see Animation and Timing System Overview.

.NET Framework
Available since 3.0
Return to top