Share via


CAnimationController::EnableStoryboardEventHandler

Visual Studio 2010 SP1 is required.

Sets or releases a handler for storyboard status and update events.

virtual BOOL EnableStoryboardEventHandler(
   UINT32 nGroupID,
   BOOL bEnable = TRUE
);

Parameters

  • nGroupID
    Specifies Group ID.

  • bEnable
    Specifies whether to set or release a handler.

Return Value

TRUE if the handler was successfully set or released; FALSE if the specified animation group is now found or animation for the specified group has not been initiated and its internal storyboard is NULL.

Remarks

When a handler is set (enabled) Windows Animation API calls OnStoryboardStatusChanges and OnStoryboardUpdated virtual methods. A handler must be set after CAnimationController::Animate has been called for the specified animation group, because it creates encapsulated IUIAnimationStoryboard object.

Requirements

Header: afxanimationcontroller.h

See Also

Reference

CAnimationController Class