Clock Class


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

Maintains run-time timing state for a Timeline.

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

public class Clock : DispatcherObject


Initializes a new instance of the Clock class, using the specified Timeline as a template. The new Clock object has no children.


Gets a ClockController that can be used to start, pause, resume, seek, skip, stop, or remove this Clock.


Gets the rate at which the clock's time is currently progressing, compared to real-world time.


Gets the current global time, as established by the WPF timing system. 


Get the current iteration of this clock.


Gets the current progress of this Clock within its current iteration.


Gets a value indicating whether the clock is currently Active, Filling, or Stopped.


Gets this clock's current time within its current iteration.


Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)


Gets a value that indicates whether this Clock is part of a controllable clock tree.


Gets a value that indicates whether this Clock, or any of its parents, is paused.


Gets the natural duration of this clock's Timeline.


Gets the clock that is the parent of this clock.


Gets the Timeline from which this Clock was created.


Determines whether the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)


When implemented in a derived class, will be invoked whenever a clock repeats, skips, or seeks.


Determines whether the specified object is equal to the current object.(Inherited from Object.)


Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)


Returns whether the Clock has its own external time source, which may require synchronization with the timing system.


Gets this clock's current time within its current iteration.


Serves as the default hash function. (Inherited from Object.)


Gets the Type of the current instance.(Inherited from Object.)


Creates a shallow copy of the current Object.(Inherited from Object.)


When implemented in a derived class, will be invoked whenever a clock begins, skips, pauses, resumes, or when the clock's SpeedRatio is modified.


When implemented in a derived class, will be invoked whenever a clock is stopped using the Stop method.


Returns a string that represents the current object.(Inherited from Object.)


Enforces that the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)


Occurs when this clock has completely finished playing.


Occurs when the clock's speed is updated.


Occurs when the clock's CurrentState property is updated.


Occurs when this clock's CurrentTime becomes invalid.


Occurs when the Remove method is called on this Clock or one of its parent clocks.

A Timeline, by itself, doesn't actually do anything other than describe a segment of time. It's the timeline's Clock object that does the real work: it maintains timing-related run-time state for the timeline.

In most cases, a clock is created automatically for your timeline. When you animate by using a Storyboard or the BeginAnimation method, clocks are automatically created for your timelines and animations and applied to their targeted properties. For examples, see How to: Animate a Property by Using a Storyboard and How to: Animate a Property Without Using a Storyboard.

You can also create a Clock explicitly by using the CreateClock method. In performance-intensive scenarios, such as animating large numbers of similar objects, managing your own Clock use can provide performance benefits.

Clocks are arranged in trees that match the structure of the Timeline objects tree from which they are created. The root clock of such a timing tree can be interactively manipulated (paused, resumed, stopped, and so on) by retrieving its Controller. Non-root clocks cannot be directly controlled.

Once created, a clock cannot be modified (but it can be manipulated).

A timeline's clock will only progress when there's an event handler associated with it or (in the case of an AnimationClock object) it is associated with a property. For this reason (and others), it's not recommended that you use a Timeline as a timer.

Notes to Inheritors:

Derived classes should implement GetCurrentTimeCore if they want to modify how time flows for this clock. Derived classes can be made to do additional work when the clock repeats, skips, seeks, begins, pauses, resumes, or stops by overriding the DiscontinuousTimeMovement, SpeedChanged, and Stopped methods.

.NET Framework
Available since 3.0

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

Return to top