IUIAnimationStoryboardEventHandler2::OnStoryboardStatusChanged method (uianimation.h)

Handles storyboard status change events.

Syntax

HRESULT OnStoryboardStatusChanged(
  [in] IUIAnimationStoryboard2        *storyboard,
  [in] UI_ANIMATION_STORYBOARD_STATUS newStatus,
  [in] UI_ANIMATION_STORYBOARD_STATUS previousStatus
);

Parameters

[in] storyboard

The storyboard for which the status has changed.

[in] newStatus

The new status.

[in] previousStatus

The previous status.

Return value

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

Remarks

By default, a call made in a callback method to any other animation method results in the call failing and returning UI_E_ILLEGAL_REENTRANCY. However, there are exceptions to this default. The following methods can be successfully called from OnStoryboardStatusChanged:

• IUIAnimationManager2::CreateAnimationVariable
• IUIAnimationManager2::CreateStoryboard
• IUIAnimationManager2::GetStoryboardFromTag
• IUIAnimationManager2::GetVariableFromTag
• IUIAnimationStoryboard2::Abandon
• IUIAnimationStoryboard2::AddKeyframeAtOffset
• IUIAnimationStoryboard2::AddKeyframeAfterTransition
• IUIAnimationStoryboard2::AddTransition
• IUIAnimationStoryboard2::AddTransitionAtKeyframe
• IUIAnimationStoryboard2::AddTransitionBetweenKeyframes
• IUIAnimationStoryboard2::Conclude
• IUIAnimationStoryboard2::Finish
• IUIAnimationStoryboard2::GetTag
• IUIAnimationStoryboard2::HoldVariable
• IUIAnimationStoryboard2::RepeatBetweenKeyframes
• IUIAnimationStoryboard2::SetLongestAcceptableDelay
• IUIAnimationStoryboard2::SetStoryboardEventHandler
• IUIAnimationStoryboard2::SetTag
• IUIAnimationStoryboard2::Schedule
• IUIAnimationTransition2::GetDuration
• IUIAnimationTransition2::IsDurationKnown
• IUIAnimationTransition2::SetInitialValue
• IUIAnimationTransition2::SetInitialVelocity
• IUIAnimationVariable2::GetCurrentStoryboard
• IUIAnimationVariable2::GetFinalIntegerValue
• IUIAnimationVariable2::GetFinalValue
• IUIAnimationVariable2::GetIntegerValue
• IUIAnimationVariable2::GetPreviousIntegerValue
• IUIAnimationVariable2::GetPreviousValue
• IUIAnimationVariable2::GetTag
• IUIAnimationVariable2::GetValue
• IUIAnimationVariable2::SetTag

Requirements

See also

IUIAnimationStoryboard2

IUIAnimationStoryboard2::GetStatus

IUIAnimationStoryboardEventHandler2

UI_ANIMATION_STORYBOARD_STATUS