IUIAnimationStoryboardEventHandler2::OnStoryboardUpdated method (uianimation.h)

Handles storyboard update events.

Syntax

HRESULT OnStoryboardUpdated(
  [in] IUIAnimationStoryboard2 *storyboard
);

Parameters

[in] storyboard

The storyboard that has been updated.

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

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

• IUIAnimationManager2::GetStoryboardFromTag
• IUIAnimationManager2::GetVariableFromTag
• IUIAnimationStoryboard2::GetTag
• IUIAnimationVariable2::GetCurrentStoryboard
• IUIAnimationVariable2::GetFinalIntegerValue
• IUIAnimationVariable2::GetFinalValue
• IUIAnimationVariable2::GetIntegerValue
• IUIAnimationVariable2::GetPreviousIntegerValue
• IUIAnimationVariable2::GetPreviousValue
• IUIAnimationVariable2::GetTag
• IUIAnimationVariable2::GetValue

Requirements

Requirement	Value
Minimum supported client	Windows 8, Windows 7 and Platform Update for Windows 7 [desktop apps | UWP apps]
Minimum supported server	None supported
Target Platform	Windows
Header	uianimation.h
DLL	UIAnimation.dll

See also

IUIAnimationManager2::Update

IUIAnimationStoryboard2

IUIAnimationStoryboard2::GetElapsedTime

IUIAnimationStoryboardEventHandler2