IXRStoryboard::Seek (Compact 2013)

3/28/2014

This method advances a storyboard to the specified position in the timeline. The storyboard performs the requested seek when the next clock tick occurs.

Syntax

virtual HRESULT STDMETHODCALLTYPE Seek(
    __in XRTimeSpan* pOffset
) = 0;

Parameters

• pOffset
  [in] Pointer to an XRTimeSpan structure that indicates a positive or negative time value that describes how far the timeline should move forward or backward from the beginning of the animation.

Return Value

Returns an HRESULT that indicates success or failure.

Remarks

To jump to a new position in the timeline of a storyboard, call this method after you call IXRStoryboard::Begin.

If an easing function is applied to the keyframes, this method jumps straight to the point in time given by pOffset, with no interpolation. Custom easing functions must use the value passed as the NormalizedTime reference in the IXREasingFunctionBase::Ease method to calculate where the easing method should be in the animation.

.NET Framework Equivalent

System.Windows.Media.Animation.Storyboard.Seek

Requirements

See Also

Reference

IXRStoryboard