HandoffBehavior Enum
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Specifies how new animations interact with any existing ones that are already applied to a property.
public enum class HandoffBehaviorpublic enum HandoffBehaviortype HandoffBehavior = Public Enum HandoffBehavior- Inheritance
Fields
| Name | Value | Description |
|---|---|---|
| SnapshotAndReplace | 0 | New animations replace any existing animations on the properties to which they are applied. |
| Compose | 1 | New animations are combined with existing animations by appending the new animations to the end of the composition chain. |
Remarks
When you apply a Storyboard, AnimationTimeline, or AnimationClock to a property by using Compose, 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 Compose, 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(DependencyProperty, AnimationClock) or BeginAnimation(DependencyProperty, AnimationTimeline) method of the animated object. Specify the property being animated as the first parameter, and
nullas the second. This will remove all animation clocks from the property.To remove a specific AnimationClock from a list of clocks, use the Controller 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 Controller 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.
