IUIAnimationStoryboard2 interface

Defines a storyboard, which contains a group of transitions that are synchronized relative to one another.

In this section

Topic	Description
Abandon Method	Terminates the storyboard, releases all related animation variables, and removes the storyboard from the schedule.
AddKeyframeAfterTransition Method	Adds a keyframe at the end of the specified transition.
AddKeyframeAtOffset Method	Adds a keyframe at the specified offset from an existing keyframe.
AddTransition Method	Adds a transition to the storyboard.
AddTransitionAtKeyframe Method	Adds a transition that starts at the specified keyframe.
AddTransitionBetweenKeyframes Method	Adds a transition between two keyframes.
Conclude Method	Completes the current iteration of a keyframe loop that is in progress (where the loop is set to UI_ANIMATION_REPEAT_INDEFINITELY), terminates the loop, and continues with the storyboard.
Finish Method	Finishes the storyboard within the specified time, compressing the storyboard if necessary.
GetElapsedTime Method	Gets the time that has elapsed since the storyboard started playing.
GetStatus Method	Gets the status of the storyboard.
GetTag Method	Gets the tag for a storyboard.
HoldVariable Method	Directs the storyboard to hold the specified animation variable at its final value until the storyboard ends.
RepeatBetweenKeyframes Method	Creates a loop between two keyframes.
Schedule Method	Directs the storyboard to schedule itself for play.
SetSkipDuration Method	Specifies an offset from the beginning of a storyboard at which to start animating.
SetLongestAcceptableDelay Method	Sets the longest acceptable delay before the scheduled storyboard begins.
SetStoryboardEventHandler Method	Specifies a handler for storyboard events.
SetTag Method	Sets the tag for the storyboard.

When to implement

Client applications do not implement this interface; custom implementations are not supported.

When to use

Client applications use IUIAnimationStoryboard2 to build animations.

Use the IUIAnimationManager2::CreateStoryboard method to create a new storyboard, and the IUIAnimationVariable2 interface to store values that can be animated by Windows Animation.

Members

The IUIAnimationStoryboard2 interface inherits from the IUnknown interface. IUIAnimationStoryboard2 also has these types of members:

Methods

Methods

The IUIAnimationStoryboard2 interface has these methods.

Method	Description
Abandon	Terminates the storyboard, releases all related animation variables, and removes the storyboard from the schedule.
AddKeyframeAfterTransition	Adds a keyframe at the end of the specified transition.
AddKeyframeAtOffset	Adds a keyframe at the specified offset from an existing keyframe.
AddTransition	Adds a transition to the storyboard.
AddTransitionAtKeyframe	Adds a transition that starts at the specified keyframe.
AddTransitionBetweenKeyframes	Adds a transition between two keyframes.
Conclude	Completes the current iteration of a keyframe loop that is in progress (where the loop is set to UI_ANIMATION_REPEAT_INDEFINITELY), terminates the loop, and continues with the storyboard.
Finish	Finishes the storyboard within the specified time, compressing the storyboard if necessary.
GetElapsedTime	Gets the time that has elapsed since the storyboard started playing.
GetStatus	Gets the status of the storyboard.
GetTag	Gets the tag for a storyboard.
HoldVariable	Directs the storyboard to hold the specified animation variable at its final value until the storyboard ends.
RepeatBetweenKeyframes	Creates a loop between two keyframes.
Schedule	Directs the storyboard to schedule itself for play.
SetLongestAcceptableDelay	Sets the longest acceptable delay before the scheduled storyboard begins.
SetSkipDuration	Specifies an offset from the beginning of a storyboard at which to start animating.
SetStoryboardEventHandler	Specifies a handler for storyboard events.
SetTag	Sets the tag for the storyboard.

Remarks

IUIAnimationStoryboard2 is the primary component for building animations, along with IUIAnimationVariable2 and IUIAnimationTransition2.

Requirements

Minimum supported client	Windows 8, Windows 7 and Platform Update for Windows 7 [desktop apps \| Windows Store apps]
Minimum supported server	None supported
Header	UIAnimation.h
IDL	UIAnimation.idl
DLL	UIAnimation.dll
IID	IID_IUIAnimationStoryboard2 is defined as AE289CD2-12D4-4945-9419-9E41BE034DF2