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

Parameters

dp
Type: System.Windows.DependencyProperty

The property to animate.

clock
Type: System.Windows.Media.Animation.AnimationClock

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

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

Implements

IAnimatable.ApplyAnimationClock(DependencyProperty, AnimationClock, HandoffBehavior)

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

Using the Compose HandoffBehavior

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

Supported in: 4.5.3, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft