IUIAnimationStoryboard interface
Defines a storyboard, which contains a group of transitions that are synchronized relative to one another.
When to implement
Client applications do not implement IUIAnimationStoryboard; custom implementations are not supported.
When to use
Client applications use IUIAnimationStoryboard to build animations. Use IUIAnimationManager::CreateStoryboard to create a new storyboard, and IUIAnimationVariable to store values that can be animated by Windows Animation.
Members
The IUIAnimationStoryboard interface inherits from the IUnknown interface. IUIAnimationStoryboard also has these types of members:
Methods
The IUIAnimationStoryboard interface has these methods.
| Method | Description |
|---|---|
| Abandon |
Directs the storyboard to abandon playing. |
| AddKeyframeAfterTransition |
Adds a keyfame at the end of the specified transition. |
| AddKeyframeAtOffset |
Adds a keyfame 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 |
Directs the storyboard to conclude. |
| Finish |
Directs the storyboard to finish playing within the specified time. |
| GetElapsedTime |
Gets the time elapsed since the storyboard started playing. |
| GetStatus |
Gets the status of the storyboard. |
| GetTag |
Gets the tag for the 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 specified keyframes. |
| Schedule |
Directs the storyboard to schedule itself for play. |
| SetLongestAcceptableDelay |
Sets the longest acceptable delay before the scheduled storyboard begins. |
| SetStoryboardEventHandler |
Specifies a handler for storyboard events. |
| SetTag |
Sets the tag for the storyboard. |
Remarks
IUIAnimationStoryboard is a primary component for building animations, along with IUIAnimationVariable and IUIAnimationTransition.
Requirements
|
Minimum supported client |
Windows 7, Windows Vista and Platform Update for Windows Vista [desktop apps | Windows Store apps] |
|---|---|
|
Minimum supported server |
None supported |
|
Header |
|
|
IDL |
|
|
DLL |
|
|
IID |
IID_IUIAnimationStoryboard is defined as A8FF128F-9BF9-4af1-9E67-E5E410DEFB84 |
See also
- IUnknown
- Storyboard Overview
- IUIAnimationManager::CreateStoryboard
- IUIAnimationManager::GetStoryboardFromTag
- IUIAnimationManager::AbandonAllStoryboards
- IUIAnimationManager::FinishAllStoryboards
- IUIAnimationVariable::GetCurrentStoryboard