IUIAnimationStoryboardEventHandler::OnStoryboardUpdated method (uianimation.h)

Handles events that occur when a storyboard is updated.

Syntax

HRESULT OnStoryboardUpdated(
  [in] IUIAnimationStoryboard *storyboard
);

Parameters

[in] storyboard

The storyboard that has been updated.

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

This method is called when the value of at least one of the variables that a storyboard is animating has changed since the last call to the IUIAnimationManager::Update method.

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 OnStoryboardUpdated:

• IUIAnimationManager::GetStoryboardFromTag
• IUIAnimationManager::GetVariableFromTag
• IUIAnimationStoryboard::GetTag
• IUIAnimationVariable::GetCurrentStoryboard
• IUIAnimationVariable::GetFinalIntegerValue
• IUIAnimationVariable::GetFinalValue
• IUIAnimationVariable::GetIntegerValue
• IUIAnimationVariable::GetPreviousIntegerValue
• IUIAnimationVariable::GetPreviousValue
• IUIAnimationVariable::GetTag
• IUIAnimationVariable::GetValue

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

IUIAnimationManager::Update

IUIAnimationStoryboard

IUIAnimationStoryboard::GetElapsedTime

IUIAnimationStoryboardEventHandler