IUIAnimationStoryboard::AddTransitionAtKeyframe method (uianimation.h)

Article
07/27/2022

Adds a transition that starts at the specified keyframe.

Syntax

HRESULT AddTransitionAtKeyframe(
  [in] IUIAnimationVariable   *variable,
  [in] IUIAnimationTransition *transition,
  [in] UI_ANIMATION_KEYFRAME  startKeyframe
);

Parameters

[in] variable

The animation variable for which a transition is to be added.

[in] transition

The transition to be added.

[in] startKeyframe

The keyframe that specifies the beginning of the new transition.

Return value

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_TRANSITION_ALREADY_USED	This transition has already been added to a storyboard or has been added to a storyboard that has finished playing and been released.
UI_E_TRANSITION_ECLIPSED	The transition might eclipse the beginning of another transition in the storyboard.

Remarks

Transitions must be added in the order in which they will be played. A transition may begin playing before the preceding transition in the storyboard has finished, in which case the initial value and velocity seen by the new transition is determined by the state of the preceding one. A transition should not begin before the start of the preceding transition.

A keyframe represents a moment in time within a storyboard and can be used to specify the start and 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.

Requirements

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