This topic has not yet been rated - Rate this topic

ClockController.Seek Method

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

Namespace:  System.Windows.Media.Animation
Assembly:  PresentationCore (in PresentationCore.dll)
public void Seek(
	TimeSpan offset,
	TimeSeekOrigin origin
)

Parameters

offset
Type: System.TimeSpan

The seek offset, measured in the target clock's time. This offset is relative to the clock's BeginTime or Duration, depending on the value of origin.

origin
Type: System.Windows.Media.Animation.TimeSeekOrigin

A value that indicates whether the specified offset is relative to the target clock's BeginTime or Duration.

Seek operations do not take the SpeedRatio or SlipBehavior settings of this clock's timeline into account: the clock is treated as though its timeline has a SpeedRatio of 1 and no SlipBehavior.

This method changes the clock's CurrentState to Active. This method has no effect on the timing tree until the next time a tick is processed. As a side-effect, the appropriate events also will not be raised until then.

Seeking a storyboard triggers the CurrentGlobalSpeedInvalidated and CurrentStateInvalidated events.

If the target clock has children, their current time is updated accordingly.

The following example shows how to seek using a ClockController.

using System;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Media;
using System.Windows.Media.Animation;
using System.Windows.Navigation;
using System.Windows.Shapes;
using System.Data;
using System.Xml;
using System.Configuration;



namespace SDKSample
{
    /// <summary> 
    /// Shows how to interactively control a clock. 
    /// </summary> 

  public class SeekAlignedToLastTickExample : Page
    {

        private AnimationClock myClock;
        private TextBlock currentTimeIndicator;
        private TextBox seekDestination;
        private TextBlock rectangleWidthIndicator;
        private Rectangle myRectangle;

        public SeekAlignedToLastTickExample()
        {



            this.WindowTitle = "Controlling a Storyboard";
            this.Background = Brushes.White;

            StackPanel myStackPanel = new StackPanel();
            myStackPanel.Margin = new Thickness(20);

            // Create a rectangle.
            myRectangle = new Rectangle();
            myRectangle.Width = 100;
            myRectangle.Height = 20;
            myRectangle.Margin = new Thickness(12,0,0,5);
            myRectangle.Fill = new SolidColorBrush(Color.FromArgb(170, 51, 51, 255));
            myRectangle.HorizontalAlignment = HorizontalAlignment.Left;
            myStackPanel.Children.Add(myRectangle);                    

            // 
            // Create an animation and a storyboard to animate the 
            // rectangle. 
            //
            DoubleAnimation myDoubleAnimation = 
                new DoubleAnimation(100, 500, new Duration(TimeSpan.FromSeconds(60)));  
            myClock = myDoubleAnimation.CreateClock();
            myRectangle.ApplyAnimationClock(Rectangle.WidthProperty, myClock);
            myClock.Controller.Stop();


            // 
            // Create some buttons to control the storyboard 
            // and a panel to contain them. 
            //
            StackPanel buttonPanel = new StackPanel();
            buttonPanel.Orientation = Orientation.Horizontal;
            Button beginButton = new Button();
            beginButton.Content = "Begin";
            beginButton.Click += new RoutedEventHandler(beginButton_Clicked);            
            buttonPanel.Children.Add(beginButton);
            Button pauseButton = new Button();
            pauseButton.Content = "Pause";
            pauseButton.Click +=new RoutedEventHandler(pauseButton_Clicked);
            buttonPanel.Children.Add(pauseButton);
            Button resumeButton = new Button();
            resumeButton.Content = "Resume";
            resumeButton.Click +=new RoutedEventHandler(resumeButton_Clicked);
            buttonPanel.Children.Add(resumeButton);
            Button skipToFillButton = new Button();
            skipToFillButton.Content = "Skip to Fill";
            skipToFillButton.Click +=new RoutedEventHandler(skipToFillButton_Clicked);
            buttonPanel.Children.Add(skipToFillButton);
            Button setSpeedRatioButton = new Button();
            setSpeedRatioButton.Content = "Triple Speed";
            setSpeedRatioButton.Click +=new RoutedEventHandler(setSpeedRatioButton_Clicked);
            buttonPanel.Children.Add(setSpeedRatioButton);
            Button stopButton = new Button();
            stopButton.Content = "Stop";
            stopButton.Click +=new RoutedEventHandler(stopButton_Clicked);
            buttonPanel.Children.Add(stopButton);
            Button removeButton = new Button();
            removeButton.Content = "Remove";
            removeButton.Click +=new RoutedEventHandler(removeButton_Clicked);
            buttonPanel.Children.Add(removeButton);            

            myStackPanel.Children.Add(buttonPanel);    

            // Create some controls to display the 
            // storyboard's current time and the 
            // current width of the rectangle.
            StackPanel seekPanel = new StackPanel();
            seekPanel.Margin = new Thickness(10);
            StackPanel aPanel = new StackPanel();
            Label aLabel = new Label();
            aPanel.Orientation = Orientation.Horizontal;
            aLabel.Content = "Current Time: ";
            aPanel.Children.Add(aLabel);
            currentTimeIndicator = new TextBlock();
            aPanel.Children.Add(currentTimeIndicator);
            seekPanel.Children.Add(aPanel);

            aPanel = new StackPanel();
            aPanel.Orientation = Orientation.Horizontal;
            aLabel = new Label();
            aLabel.Content = "Rectangle Width: ";
            aPanel.Children.Add(aLabel);
            rectangleWidthIndicator = new TextBlock();
            rectangleWidthIndicator.Text = myRectangle.Width.ToString(); 
            aPanel.Children.Add(rectangleWidthIndicator);
            seekPanel.Children.Add(aPanel);


            // Create some controls to enable the 
            // user to specify a seek position.

            aPanel = new StackPanel();
            aPanel.Orientation = Orientation.Horizontal;
            aLabel = new Label();
            aLabel.Content = "Seek Offset: " ;
            aPanel.Children.Add(aLabel);
            seekDestination = new TextBox();
            seekDestination.Text = "0";
            aPanel.Children.Add(seekDestination);       
            seekPanel.Children.Add(aPanel);


            Button seekButton = new Button();
            seekButton.Content = "Seek";
            seekButton.Click += new RoutedEventHandler(seekButton_Clicked);
            seekPanel.Children.Add(seekButton);
            Button seekAlignedToLastTickButton = new Button();
            seekAlignedToLastTickButton.Content = "Seek Aligned to Last Tick";
            seekAlignedToLastTickButton.Click += new RoutedEventHandler(seekAlignedToLastTickButton_Clicked);
            seekPanel.Children.Add(seekAlignedToLastTickButton);           

            myStackPanel.Children.Add(seekPanel);

            this.Content = myStackPanel;   

            myClock.CurrentTimeInvalidated += new EventHandler(myClock_CurrentTimeInvalidated);
        }

        // Begins the clock. 
        private void beginButton_Clicked(object sender, RoutedEventArgs args)
        {

            myClock.Controller.Begin();         
        }

        // Pauses the clock. 
        private void pauseButton_Clicked(object sender, RoutedEventArgs args)
        {
            myClock.Controller.Pause();         

        }

        // Resumes the clock. 
        private void resumeButton_Clicked(object sender, RoutedEventArgs args)
        {
            myClock.Controller.Resume();        

        }

        // Advances the clock to its fill period. 
        private void skipToFillButton_Clicked(object sender, RoutedEventArgs args)
        {
            myClock.Controller.SkipToFill();          

        }

        // Updates the clock's speed. 
        private void setSpeedRatioButton_Clicked(object sender, RoutedEventArgs args)
        {
            // Makes the clock progress three times as fast as normal.
            myClock.Controller.SpeedRatio = 3;        

        }

        // Stops the clock. 
        private void stopButton_Clicked(object sender, RoutedEventArgs args)
        {
            myClock.Controller.Stop();        

        }

        // Removes the clock. 
        private void removeButton_Clicked(object sender, RoutedEventArgs args)
        {
            myClock.Controller.Remove();        

        }        

        private void seekButton_Clicked(object sender, RoutedEventArgs args)
        {
            try {

                // The rectangle width will probably not be at its new 
                // value when this call is made, because the  
                // clock probably hasn't ticked yet.
                TimeSpan seekTime = TimeSpan.Parse(seekDestination.Text);
                myClock.Controller.Seek(seekTime, TimeSeekOrigin.BeginTime);
                rectangleWidthIndicator.Text = myRectangle.Width.ToString();

            }catch(FormatException ex)
            {
                MessageBox.Show("Invalid TimeSpan value.");
                seekDestination.Focus();
            }
        }

        private void seekAlignedToLastTickButton_Clicked(object sender, RoutedEventArgs args)
        {

            try {

                // The rectangle width will be at its new 
                // value when this call is made, because SeekAlignedToLastTick  
                // operation immediately updates timeline and animation 
                // values.        
                TimeSpan seekTime = TimeSpan.Parse(seekDestination.Text);
                myClock.Controller.SeekAlignedToLastTick(seekTime, TimeSeekOrigin.BeginTime);
                rectangleWidthIndicator.Text = myRectangle.Width.ToString();

            }catch(FormatException ex)
            {
                MessageBox.Show("Invalid TimeSpan value.");
                seekDestination.Focus();
            }    
        }

        private void myClock_CurrentTimeInvalidated(object sender, EventArgs e)
        {

            currentTimeIndicator.Text = myClock.CurrentTime.ToString();

        }



    }
}

More Code

How to: Interactively Control a ClockA 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.

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, 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.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.