This documentation is archived and is not being maintained.

ClockController Class

Interactively controls a Clock.

System::Object
  System.Windows.Threading::DispatcherObject
    System.Windows.Media.Animation::ClockController

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

public ref class ClockController sealed : public DispatcherObject

The ClockController type exposes the following members.

  NameDescription
Public propertyClockGets the Clock controlled by this ClockController.
Public propertyDispatcherGets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)
Public propertySpeedRatioGets or sets the interactive speed of the target Clock.
Top

  NameDescription
Public methodBeginSets the target Clock to begin at the next tick.
Public methodCheckAccessDetermines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
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.)
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.)
Public methodPauseStops the target Clock from progressing.
Public methodRemoveRemoves the Clock associated with this ClockController from the properties it animates. The clock and its child clocks will no longer affect these properties.
Public methodResumeEnables a Clock that was previously paused to resume progressing.
Public methodSeekSeeks the target Clock by the specified amount when the next tick occurs. If the target clock is stopped, seeking makes it active again.
Public methodSeekAlignedToLastTickSeeks the target Clock by the specified amount immediately. If the target clock is stopped, seeking makes it active again.
Public methodSkipToFillAdvances the current time of the target Clock to the end of its active period.
Public methodStopStops the target 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.)
Top

Use a ClockController to interactively begin, pause, resume, seek, skip, stop, and remove a Clock. You can only interactively control root-level clocks.

A Clock object's ClockController property enables you to interactively start, pause, resume, seek, advance the clock to its fill period, and stop the clock. Only the root clock of a timing tree can be interactively controlled.

NoteNote

There are other ways to interactively control animations that don't require you to work directly with clocks: you can also use Storyboards. Storyboards are supported in both markup and code. For an example, see How to: Animate a Property by Using a Storyboard or the Animation Overview.

In the following example, several buttons are used to interactively control an animation clock.

No code example is currently available or this language may not be supported.

.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.
Show: