IUIAnimationStoryboardEventHandler::OnStoryboardStatusChanged method (uianimation.h)

Handles events that occur when a storyboard's status changes.

Syntax

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

Parameters

[in] storyboard

The storyboard whose status has changed.

[in] newStatus

The new status.

[in] previousStatus

The previous status.

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.

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:

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

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

See also

IUIAnimationStoryboard

IUIAnimationStoryboard::GetStatus

IUIAnimationStoryboardEventHandler

UI_ANIMATION_STORYBOARD_STATUS