This documentation is archived and is not being maintained.

AnimationClock Class

Maintains the run-time state of an AnimationTimeline and processes its output values.

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

public class AnimationClock : Clock

The AnimationClock type exposes the following members.

Protected methodAnimationClock Initializes a new instance of the AnimationClock class.

Public propertyControllerGets a ClockController that can be used to start, pause, resume, seek, skip, stop, or remove this Clock. (Inherited from Clock.)
Public propertyCurrentGlobalSpeedGets the rate at which the clock's time is currently progressing, compared to real-world time. (Inherited from Clock.)
Protected propertyCurrentGlobalTimeGets the current global time, as established by the WPF timing system.  (Inherited from Clock.)
Public propertyCurrentIterationGet the current iteration of this clock. (Inherited from Clock.)
Public propertyCurrentProgressGets the current progress of this Clock within its current iteration. (Inherited from Clock.)
Public propertyCurrentStateGets a value indicating whether the clock is currently Active, Filling, or Stopped. (Inherited from Clock.)
Public propertyCurrentTimeGets this clock's current time within its current iteration. (Inherited from Clock.)
Public propertyDispatcherGets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)
Public propertyHasControllableRootGets a value that indicates whether this Clock is part of a controllable clock tree. (Inherited from Clock.)
Public propertyIsPausedGets a value that indicates whether this Clock, or any of its parents, is paused. (Inherited from Clock.)
Public propertyNaturalDurationGets the natural duration of this clock's Timeline. (Inherited from Clock.)
Public propertyParentGets the clock that is the parent of this clock. (Inherited from Clock.)
Public propertyTimelineGets the AnimationTimeline that describes this clock's behavior.

Public methodCheckAccessDetermines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Protected methodDiscontinuousTimeMovementWhen implemented in a derived class, will be invoked whenever a clock repeats, skips, or seeks. (Inherited from Clock.)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Protected methodGetCanSlipReturns whether the Clock has its own external time source, which may require synchronization with the timing system. (Inherited from Clock.)
Protected methodGetCurrentTimeCoreGets this clock's current time within its current iteration. (Inherited from Clock.)
Public methodGetCurrentValueGets the current output value of the AnimationClock.
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodSpeedChangedWhen implemented in a derived class, will be invoked whenever a clock begins, skips, pauses, resumes, or when the clock's SpeedRatio is modified. (Inherited from Clock.)
Protected methodStoppedWhen implemented in a derived class, will be invoked whenever a clock is stopped using the Stop method. (Inherited from Clock.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodVerifyAccessEnforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)

Public eventCompletedOccurs when this clock has completely finished playing. (Inherited from Clock.)
Public eventCurrentGlobalSpeedInvalidatedOccurs when the clock's speed is updated. (Inherited from Clock.)
Public eventCurrentStateInvalidatedOccurs when the clock's CurrentState property is updated. (Inherited from Clock.)
Public eventCurrentTimeInvalidatedOccurs when this clock's CurrentTime becomes invalid. (Inherited from Clock.)
Public eventRemoveRequestedOccurs when the Remove method is called on this Clock or one of its parent clocks. (Inherited from Clock.)

AnimationClock objects are generated from AnimationTimeline objects. An AnimationTimeline describes an animation's output values, duration, begin time, end time, and other fundamental animation information. An AnimationClock processes the animation values described by an AnimationTimeline object.

This example shows how to use Clock objects to animate a property.

There are three ways to animate a dependency property:

Storyboard objects and the BeginAnimation method enable you to animate properties without directly creating and distributing clocks (for examples, see How to: Animate a Property by Using a Storyboard and How to: Animate a Property Without Using a Storyboard); clocks are created and distributed for you automatically.

The following example shows how to create an AnimationClock and apply it to two similar properties.

    This example shows how to create and apply
    an AnimationClock.

using System;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Media;
using System.Windows.Shapes;
using System.Windows.Media.Animation;

namespace Microsoft.Samples.Animation.TimingBehaviors
    public class AnimationClockExample : Page

        ScaleTransform myScaleTransform;

        public AnimationClockExample()

            this.WindowTitle = "Opacity Animation Example";
            this.Background = Brushes.White;
            StackPanel myStackPanel = new StackPanel();
            myStackPanel.Margin = new Thickness(20);

            // Create a button that with a ScaleTransform.
            // The ScaleTransform will animate when the
            // button is clicked.
            Button myButton = new Button();
            myButton.Margin = new Thickness(50);
            myButton.HorizontalAlignment = HorizontalAlignment.Left;
            myButton.Content = "Click Me";           
            myScaleTransform = new ScaleTransform(1,1);
            myButton.RenderTransform = myScaleTransform;

            // Associate an event handler with the
            // button's Click event.
            myButton.Click += new RoutedEventHandler(myButton_Clicked);

            this.Content = myStackPanel;

        // Create and apply and animation when the button is clicked.
        private void myButton_Clicked(object sender, RoutedEventArgs e)

            // Create a DoubleAnimation to animate the
            // ScaleTransform.
            DoubleAnimation myAnimation = 
                new DoubleAnimation(
                    1, // "From" value
                    5, // "To" value 
                    new Duration(TimeSpan.FromSeconds(5))
            myAnimation.AutoReverse = true;

            // Create a clock the for the animation.
            AnimationClock myClock = myAnimation.CreateClock();            

            // Associate the clock the ScaleX and
            // ScaleY properties of the button's
            // ScaleTransform.
                ScaleTransform.ScaleXProperty, myClock);
                ScaleTransform.ScaleYProperty, myClock);

For an example showing how to interactively control a Clock after it starts, see How to: Interactively Control a Clock.

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.