Export (0) Print
Expand All

Storyboard.Seek Method (FrameworkElement, TimeSpan, TimeSeekOrigin)

Seeks this Storyboard to the specified position. The Storyboard performs the requested seek when the next clock tick occurs.

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

member Seek : 
        containingObject:FrameworkElement * 
        offset:TimeSpan * 
        origin:TimeSeekOrigin -> unit

Parameters

containingObject
Type: System.Windows.FrameworkElement

The object specified when the Begin method was called. This object contains the Clock objects that were created for this storyboard and its children.

offset
Type: System.TimeSpan

A positive or negative value that describes the amount by which the timeline should move forward or backward from the specified origin.

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

The position from which offset is applied.

Note that seek operations do not take the storyboard's SpeedRatio or SlipBehavior settings into account. The storyboard is treated as though it has a SpeedRatio of 1 and no SlipBehavior.

This method changes the storyboard 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 are also not raised until then.

To interactively control this storyboard, you must use the same containingObject parameter when calling the interactive methods that you used to begin the storyboard. A controllable storyboard can pause, resume, seek, stop, and be removed if it is made controllable. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's Begin method and specify true to make it controllable. For an example, see How to: Control a Storyboard After It Starts.

Seeking a storyboard triggers the CurrentGlobalSpeedInvalidated and CurrentStateInvalidated events.

The following example shows how to seek (skip) to one second after a Storyboard begins.

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

The next example shows both the Seek and SeekAlignedToLastTick methods.

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

More Code

How to: Seek a StoryboardThe following example shows how to use the Seek method of a Storyboard to jump to any position in a storyboard animation.
How to: Seek a Storyboard SynchronouslyThe following example shows how to use the SeekAlignedToLastTick method of a Storyboard to seek to any position in a storyboard animation synchronously.

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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.

Show:
© 2014 Microsoft