IUIAnimationVariableIntegerChangeHandler::OnIntegerValueChanged method (uianimation.h)
Handles events that occur when the value of an animation variable changes.
This method receives updates as INT32 values. To receive updates as DOUBLE values, use the IUIAnimationVariableChangeHandler::OnValueChanged method.
Syntax
HRESULT OnIntegerValueChanged(
[in] IUIAnimationStoryboard *storyboard,
[in] IUIAnimationVariable *variable,
[in] INT32 newValue,
[in] INT32 previousValue
);
Parameters
[in] storyboard
The storyboard that is animating the animation variable specified by the variable parameter.
[in] variable
The animation variable that has been updated.
[in] newValue
The new value of the animation variable, rounded according to the variable's rounding mode.
[in] previousValue
The previous value of the animation variable, rounded according to the variable's rounding mode.
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
The rounding mode for an animation variable is specified using the IUIAnimationVariable::SetRoundingMode method.
OnIntegerValueChanged events might occur less frequently than OnValueChanged events because values such as 2.2, 2.3, 2.4 would all be rounded to the same integer.
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 OnIntegerValueChanged:
- IUIAnimationVariable::GetCurrentStoryboard
- IUIAnimationVariable::GetFinalIntegerValue
- IUIAnimationVariable::GetFinalValue
- IUIAnimationVariable::GetIntegerValue
- IUIAnimationVariable::GetPreviousIntegerValue
- IUIAnimationVariable::GetPreviousValue
- IUIAnimationVariable::GetValue
- IUIAnimationManager::GetStoryboardFromTag
- IUIAnimationManager::GetVariableFromTag
- IUIAnimationStoryboard::GetTag
- IUIAnimationVariable::GetTag
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
IUIAnimationVariable::GetIntegerValue
IUIAnimationVariable::GetPreviousIntegerValue
IUIAnimationVariable::SetRoundingMode
IUIAnimationVariable::SetVariableIntegerChangeHandler
IUIAnimationVariableChangeHandler::OnValueChanged