ClockController Class

 
System_CAPS_noteNote

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

Interactively controls a Clock.

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

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

public sealed class ClockController : DispatcherObject

NameDescription
System_CAPS_pubpropertyClock

Gets the Clock controlled by this ClockController.

System_CAPS_pubpropertyDispatcher

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

System_CAPS_pubpropertySpeedRatio

Gets or sets the interactive speed of the target Clock.

NameDescription
System_CAPS_pubmethodBegin()

Sets the target Clock to begin at the next tick.

System_CAPS_pubmethodCheckAccess()

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

System_CAPS_pubmethodEquals(Object)

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

System_CAPS_pubmethodGetHashCode()

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

System_CAPS_pubmethodGetType()

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

System_CAPS_pubmethodPause()

Stops the target Clock from progressing.

System_CAPS_pubmethodRemove()

Removes the Clock associated with this ClockController from the properties it animates. The clock and its child clocks will no longer affect these properties.

System_CAPS_pubmethodResume()

Enables a Clock that was previously paused to resume progressing.

System_CAPS_pubmethodSeek(TimeSpan, TimeSeekOrigin)

Seeks the target Clock by the specified amount when the next tick occurs. If the target clock is stopped, seeking makes it active again.

System_CAPS_pubmethodSeekAlignedToLastTick(TimeSpan, TimeSeekOrigin)

Seeks the target Clock by the specified amount immediately. If the target clock is stopped, seeking makes it active again.

System_CAPS_pubmethodSkipToFill()

Advances the current time of the target Clock to the end of its active period.

System_CAPS_pubmethodStop()

Stops the target Clock.

System_CAPS_pubmethodToString()

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

System_CAPS_pubmethodVerifyAccess()

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

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

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