IUIAnimationStoryboard2::SetSkipDuration method (uianimation.h)

Specifies an offset from the beginning of a storyboard at which to start animating.

Syntax

HRESULT SetSkipDuration(
  [in] UI_ANIMATION_SECONDS secondsDuration
);

Parameters

[in] secondsDuration

The offset, or amount of time, to skip at the beginning of the storyboard.

Return value

Returns S_OK if successful; otherwise an HRESULT error code. See Windows Animation Error Codes for a list of error codes.

Remarks

Calls to SetSkipDuration fail if the storyboard has been scheduled.

SetSkipDuration does not delay the start of a scheduled storyboard. See IUIAnimationStoryboard2::SetLongestAcceptableDelay for more info on how to set a delay for a scheduled storyboard.

This diagram shows a skip duration, or offset, for a storyboard.

Illustration of a storyboard offset

Requirements

Requirement Value
Minimum supported client Windows 8, Windows 7 and Platform Update for Windows 7 [desktop apps | UWP apps]
Minimum supported server None supported
Target Platform Windows
Header uianimation.h
DLL UIAnimation.dll

See also

IUIAnimationStoryboard2

SetLongestAcceptableDelay