Skip to content

Latest commit

 

History

History
132 lines (103 loc) · 4.95 KB

nf-uianimation-iuianimationstoryboard-repeatbetweenkeyframes.md

File metadata and controls

132 lines (103 loc) · 4.95 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:uianimation.IUIAnimationStoryboard.RepeatBetweenKeyframes
IUIAnimationStoryboard::RepeatBetweenKeyframes (uianimation.h)
Creates a loop between two specified keyframes.
IUIAnimationStoryboard interface [Windows Animation]
RepeatBetweenKeyframes method
IUIAnimationStoryboard.RepeatBetweenKeyframes
IUIAnimationStoryboard::RepeatBetweenKeyframes
RepeatBetweenKeyframes
RepeatBetweenKeyframes method [Windows Animation]
RepeatBetweenKeyframes method [Windows Animation]
IUIAnimationStoryboard interface
uianimation.iuianimationstoryboard_repeatbetweenkeyframes
uianimation/IUIAnimationStoryboard::RepeatBetweenKeyframes
uianimation\iuianimationstoryboard_repeatbetweenkeyframes.htm
UIAnimation
3c1ddb8c-fcbf-4b0c-8725-35dfc15e3c02
12/05/2018
IUIAnimationStoryboard interface [Windows Animation],RepeatBetweenKeyframes method, IUIAnimationStoryboard.RepeatBetweenKeyframes, IUIAnimationStoryboard::RepeatBetweenKeyframes, RepeatBetweenKeyframes, RepeatBetweenKeyframes method [Windows Animation], RepeatBetweenKeyframes method [Windows Animation],IUIAnimationStoryboard interface, uianimation.iuianimationstoryboard_repeatbetweenkeyframes, uianimation/IUIAnimationStoryboard::RepeatBetweenKeyframes
uianimation.h
Windows
Windows 7, Windows Vista and Platform Update for Windows Vista [desktop apps \| UWP apps]
None supported
UIAnimation.idl
UIAnimation.dll
Windows
19H1
IUIAnimationStoryboard::RepeatBetweenKeyframes
uianimation/IUIAnimationStoryboard::RepeatBetweenKeyframes
c++
APIRef
kbSyntax
COM
UIAnimation.dll
IUIAnimationStoryboard.RepeatBetweenKeyframes

IUIAnimationStoryboard::RepeatBetweenKeyframes

-description

Creates a loop between two specified keyframes.

-parameters

-param startKeyframe [in]

The keyframe at which the loop is to begin.

-param endKeyframe [in]

The keyframe at which the loop is to end. It must not be possible for endKeyframe to occur earlier in the storyboard than startKeyframe.

-param repetitionCount [in]

The number of times the loop is to be repeated; this parameter must be 0 or a positive number. Use UI_ANIMATION_REPEAT_INDEFINITELY (-1) to repeat the loop indefinitely until the storyboard is trimmed or concluded.

-returns

If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. See Windows Animation Error Codes for a list of error codes.

Return code Description
UI_E_START_KEYFRAME_AFTER_END
The start keyframe might occur after the end keyframe.
UI_E_END_KEYFRAME_NOT_DETERMINED
It might not be possible to determine the end keyframe time when the start keyframe is reached.
UI_E_LOOPS_OVERLAP
Two repeated portions of a storyboard might overlap.

-remarks

This method directs a storyboard to play the interval between the given keyframes repeatedly before playing the remainder of the storyboard. If a finite repetition count is specified, the loop always plays that number of times. If UI_ANIMATION_REPEAT_INDEFINITELY (-1) is specified, the loop repeats until the storyboard is concluded, in which case the current iteration of the loop completes and the remainder of the storyboard plays. A storyboard that loops indefinitely also ends if it is truncated.

Nested and overlapping loops are not supported.

A keyframe represents a moment in time within a storyboard and can be used to specify the start or end times of transitions. Because keyframes can be added at the ends of transitions, their offsets from the start of the storyboard may not be known until the storyboard is playing.

-see-also

IUIAnimationStoryboard

IUIAnimationStoryboard::AddKeyframeAfterTransition

IUIAnimationStoryboard::AddKeyframeAtOffset