Animatable.ApplyAnimationClock Method (DependencyProperty, AnimationClock, HandoffBehavior)


Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the specified HandoffBehavior is used.

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

abstract ApplyAnimationClock : 
        dp:DependencyProperty *
        clock:AnimationClock *
        handoffBehavior:HandoffBehavior -> unit
override ApplyAnimationClock : 
        dp:DependencyProperty *
        clock:AnimationClock *
        handoffBehavior:HandoffBehavior -> unit


Type: System.Windows.DependencyProperty

The property to animate.

Type: System.Windows.Media.Animation.AnimationClock

The clock with which to animate the specified property. If handoffBehavior is SnapshotAndReplace and clock is null, all animations will be removed from the specified property (but not stopped). If handoffBehavior is Compose and clock is null, this method has no effect.

Type: System.Windows.Media.Animation.HandoffBehavior

A value that specifies how the new animation should interact with any current animations already affecting the property value.

Note that using this method to remove clocks from a property does not stop those clocks.

When you apply a Storyboard, AnimationTimeline, or AnimationClock to a property using the Compose HandoffBehavior, any Clock objects previously associated with that property continue to consume system resources; the timing system will not remove these 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.

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 the Animation and Timing System Overview.

The following example shows how to apply animation clocks using different HandoffBehavior settings.

.NET Framework
Available since 3.0
Return to top