Export (0) Print
Expand All

Storyboard.Seek Method (FrameworkContentElement, 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:FrameworkContentElement * 
        offset:TimeSpan * 
        origin:TimeSeekOrigin -> unit

Parameters

containingObject
Type: System.Windows.FrameworkContentElement

The object specified when the Begin(FrameworkContentElement, Boolean) 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. 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 both the Seek and SeekAlignedToLastTick methods.

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

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Show:
© 2015 Microsoft