UI_ANIMATION_STORYBOARD_STATUS enumeration

Defines the status for a storyboard.

Syntax

typedef enum  { 
  UI_ANIMATION_STORYBOARD_BUILDING               = 0,
  UI_ANIMATION_STORYBOARD_SCHEDULED              = 1,
  UI_ANIMATION_STORYBOARD_CANCELLED              = 2,
  UI_ANIMATION_STORYBOARD_PLAYING                = 3,
  UI_ANIMATION_STORYBOARD_TRUNCATED              = 4,
  UI_ANIMATION_STORYBOARD_FINISHED               = 5,
  UI_ANIMATION_STORYBOARD_READY                  = 6,
  UI_ANIMATION_STORYBOARD_INSUFFICIENT_PRIORITY  = 7
} UI_ANIMATION_STORYBOARD_STATUS;

Constants

UI_ANIMATION_STORYBOARD_BUILDING

The storyboard has never been scheduled.

UI_ANIMATION_STORYBOARD_SCHEDULED

The storyboard is scheduled to play.

UI_ANIMATION_STORYBOARD_CANCELLED

The storyboard was canceled.

UI_ANIMATION_STORYBOARD_PLAYING

The storyboard is currently playing.

UI_ANIMATION_STORYBOARD_TRUNCATED

The storyboard was truncated.

UI_ANIMATION_STORYBOARD_FINISHED

The storyboard has finished playing.

UI_ANIMATION_STORYBOARD_READY

The storyboard is built and ready for scheduling.

UI_ANIMATION_STORYBOARD_INSUFFICIENT_PRIORITY

Scheduling the storyboard failed because a scheduling conflict occurred and the currently scheduled storyboard has higher priority.

Remarks

Unless IUIAnimationStoryboard::GetStatus is called from a handler for OnStoryboardStatusChanged events, it returns only the following status values:

• UI_ANIMATION_STORYBOARD_BUILDING
• UI_ANIMATION_STORYBOARD_SCHEDULED
• UI_ANIMATION_STORYBOARD_PLAYING
• UI_ANIMATION_STORYBOARD_READY

All status values can be passed to IUIAnimationStoryboardEventHandler::OnStoryboardStatusChanged.

The following diagram illustrates the transitions between these states.

Requirements

See also

IUIAnimationStoryboard::GetStatus

IUIAnimationStoryboardEventHandler::OnStoryboardStatusChanged