Interactively controls a Clock.
Assembly: PresentationCore (in PresentationCore.dll)
Thetype exposes the following members.
|Begin||Sets the target Clock to begin at the next tick.|
|CheckAccess||Determines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)|
|Equals(Object)||Determines whether the specified object is equal to the current object. (Inherited from Object.)|
|GetHashCode||Serves as a hash function for a particular type. (Inherited from Object.)|
|GetType||Gets the Type of the current instance. (Inherited from Object.)|
|Pause||Stops the target Clock from progressing.|
|Remove||Removes the Clock associated with this from the properties it animates. The clock and its child clocks will no longer affect these properties.|
|Resume||Enables a Clock that was previously paused to resume progressing.|
|Seek||Seeks the target Clock by the specified amount when the next tick occurs. If the target clock is stopped, seeking makes it active again.|
|SeekAlignedToLastTick||Seeks the target Clock by the specified amount immediately. If the target clock is stopped, seeking makes it active again.|
|SkipToFill||Advances the current time of the target Clock to the end of its active period.|
|Stop||Stops the target Clock.|
|ToString||Returns a string that represents the current object. (Inherited from Object.)|
|VerifyAccess||Enforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)|
Use a to interactively begin, pause, resume, seek, skip, stop, and remove a Clock. You can only interactively control root-level clocks.
A Clock object's 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.
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.
' ' This example shows how to interactively control ' a root clock. ' Imports System Imports System.Windows Imports System.Windows.Controls Imports System.Windows.Media Imports System.Windows.Shapes Imports System.Windows.Media.Animation Namespace Microsoft.Samples.Animation.TimingBehaviors Public Class ClockControllerExample Inherits Page Private myControllableClock As AnimationClock Private seekButton As Button Private seekAmountTextBox As TextBox Private timeSeekOriginListBox As ListBox Public Sub New() Dim mainPanel As New StackPanel() ' Create a rectangle to animate. Dim animatedRectangle As New Rectangle() animatedRectangle.Width = 100 animatedRectangle.Height = 100 animatedRectangle.Fill = Brushes.Orange mainPanel.Children.Add(animatedRectangle) ' Create a DoubleAnimation to ' animate its width. Dim widthAnimation As New DoubleAnimation(100, 500, New Duration(TimeSpan.FromSeconds(5))) ' Create a clock from the animation. myControllableClock = widthAnimation.CreateClock() ' Apply the clock to the rectangle's Width property. animatedRectangle.ApplyAnimationClock(Rectangle.WidthProperty, myControllableClock) myControllableClock.Controller.Stop() ' ' Create some buttons to control the clock. ' ' Create a button to begin the clock. Dim beginButton As New Button() beginButton.Content = "Begin" AddHandler beginButton.Click, AddressOf beginButton_Clicked mainPanel.Children.Add(beginButton) ' Create a button to pause the clock. Dim pauseButton As New Button() pauseButton.Content = "Pause" AddHandler pauseButton.Click, AddressOf pauseButton_Clicked mainPanel.Children.Add(pauseButton) ' Create a button to resume the clock. Dim resumeButton As New Button() resumeButton.Content = "Resume" AddHandler resumeButton.Click, AddressOf resumeButton_Clicked mainPanel.Children.Add(resumeButton) ' Create a button to advance the clock to ' its fill period. Dim skipToFillButton As New Button() skipToFillButton.Content = "Skip to Fill" AddHandler skipToFillButton.Click, AddressOf skipToFillButton_Clicked mainPanel.Children.Add(skipToFillButton) ' Create a button to stop the clock. Dim stopButton As New Button() stopButton.Content = "Stop" AddHandler stopButton.Click, AddressOf stopButton_Clicked mainPanel.Children.Add(stopButton) ' ' Create some controls the enable the user to ' seek the clock. ' Dim seekDetailsPanel As New StackPanel() seekDetailsPanel.Margin = New Thickness(0,20,0,20) seekDetailsPanel.Orientation = Orientation.Horizontal Dim seekAmountLabel As New Label() seekAmountLabel.Content = "Seek amount:" seekDetailsPanel.Children.Add(seekAmountLabel) ' Create a text box so that the user can ' specify the amount by which to seek. seekAmountTextBox = New TextBox() seekAmountTextBox.Text = "0:0:1" seekAmountTextBox.VerticalAlignment = VerticalAlignment.Top AddHandler seekAmountTextBox.TextChanged, AddressOf seekAmountTextBox_TextChanged seekDetailsPanel.Children.Add(seekAmountTextBox) Dim timeSeekOriginLabel As New Label() timeSeekOriginLabel.Content = "Seek Origin:" seekDetailsPanel.Children.Add(timeSeekOriginLabel) ' Create a ListBox so the user can ' select whether the seek time is relative ' to the clock's BeginTime or Duration. timeSeekOriginListBox = New ListBox() timeSeekOriginListBox.Items.Add("BeginTime") timeSeekOriginListBox.Items.Add("Duration") timeSeekOriginListBox.Padding = New Thickness(5) timeSeekOriginListBox.SelectedIndex = 0 seekDetailsPanel.Children.Add(timeSeekOriginListBox) ' Create a button to seek the clock. seekButton = New Button() seekButton.Content = "Seek" AddHandler seekButton.Click, AddressOf seekButton_Clicked seekDetailsPanel.Children.Add(seekButton) mainPanel.Children.Add(seekDetailsPanel) Me.Content = mainPanel End Sub ' Starts the clock. Private Sub beginButton_Clicked(ByVal sender As Object, ByVal e As RoutedEventArgs) myControllableClock.Controller.Begin() End Sub ' Pauses the clock. Private Sub pauseButton_Clicked(ByVal sender As Object, ByVal e As RoutedEventArgs) myControllableClock.Controller.Pause() End Sub ' Resumes the clock. Private Sub resumeButton_Clicked(ByVal sender As Object, ByVal e As RoutedEventArgs) myControllableClock.Controller.Resume() End Sub ' Adances the clock to its fill period. Private Sub skipToFillButton_Clicked(ByVal sender As Object, ByVal e As RoutedEventArgs) myControllableClock.Controller.SkipToFill() End Sub ' Stops the clock. Private Sub stopButton_Clicked(ByVal sender As Object, ByVal e As RoutedEventArgs) myControllableClock.Controller.Stop() End Sub ' Seeks the clock. Private Sub seekButton_Clicked(ByVal sender As Object, ByVal e As RoutedEventArgs) Try ' Obtain the seek amount from the seekAmountTextBox TextBox. Dim seekAmount As TimeSpan = TimeSpan.Parse(seekAmountTextBox.Text) ' Determine the seek origin by reading the selected value ' from the timeSeekOriginListBox ListBox. Dim selectedOrigin As TimeSeekOrigin = CType(System.Enum.Parse(GetType(TimeSeekOrigin), CStr(timeSeekOriginListBox.SelectedItem)), TimeSeekOrigin) ' Seek to the specified location. myControllableClock.Controller.Seek(seekAmount, selectedOrigin) Catch formatEx As FormatException MessageBox.Show(seekAmountTextBox.Text & " is not a valid TimeSpan. Please enter another value.") ' Disable the seek button until the user enters another value. seekButton.IsEnabled = False End Try End Sub ' Verifies that seekAmountTextBox has text content. ' If there is no text, disable the seek button. Private Sub seekAmountTextBox_TextChanged(ByVal sender As Object, ByVal e As TextChangedEventArgs) Dim theTextBox As TextBox = CType(e.Source, TextBox) If theTextBox.Text Is Nothing OrElse theTextBox.Text.Length < 1 Then seekButton.IsEnabled = False Else seekButton.IsEnabled = True End If End Sub End Class End Namespace
Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.