UIElement.ApplyAnimationClock Method (DependencyProperty, AnimationClock)


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

Applies an animation to a specified dependency property on this element. Any existing animations are stopped and replaced with the new animation.

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

Public Sub ApplyAnimationClock (
	dp As DependencyProperty,
	clock As AnimationClock


Type: System.Windows.DependencyProperty

The identifier for the property to animate.

Type: System.Windows.Media.Animation.AnimationClock

The animation clock that controls and declares the animation.

To remove an animation from a property, specify the identifier for that property as dp and specify clock as null. This removes the animation and the animated property is set to its base value. However, the originally associated animation clock is not stopped. Any other animations assigned to that clock will continue to run.

In the following example, a Rectangle myAnimatedRectangle has a particular timing animation applied to it by calling ApplyAnimationClock .

' Create a DoubleAnimation to
' animate its width.
Dim widthAnimation As New DoubleAnimation(100, 500, New Duration(TimeSpan.FromSeconds(5)))
'widthAnimation.RepeatBehavior = RepeatBehavior.Forever
widthAnimation.AutoReverse = True
widthAnimation.SpeedRatio = 0.5

' Create a clock from the animation.
myControllableClock = widthAnimation.CreateClock()

' Apply the clock to the rectangle's Width property.
animatedRectangle.ApplyAnimationClock(Rectangle.WidthProperty, myControllableClock)

.NET Framework
Available since 3.0
Return to top