CMFCRibbonPanel::SetElementMenu

Assigns a popup menu to the element that has the given command ID.

BOOL SetElementMenu(
    UINT uiCmdID,
    HMENU hMenu,
    BOOL bIsDefautCommand = FALSE,
    BOOL bRightAlign = FALSE
);
BOOL SetElementMenu(
    UINT uiCmdID,
    UINT uiMenuResID,
    BOOL bIsDefautCommand = FALSE,
    BOOL bRightAlign = FALSE
);

Parameters

  • [in] uiCmdID
    Specifies the command ID of the ribbon element where the menu is added.

  • [in] hMenu
    Specifies the handle to the Windows menu to add to the ribbon panel.

  • [in] bIsDefautCommand
    TRUE to specify that the command associated with the ribbon element should be executed if the ribbon element is clicked. In this case, the menu is only opened when the user clicks the arrow next to the ribbon element. FALSE to specify that the command associated with the ribbon element should not be executed if the ribbon element is clicked. In this case, the popup menu appears regardless of where the user clicks on the element.

  • [in] bRightAlign
    TRUE to specify that the popup menu is right-aligned; otherwise, FALSE.

  • [in] uiMenuResID
    Specifies the resource ID of the menu to add to the ribbon panel.

Return Value

TRUE if the menu has been assigned to the ribbon element; otherwise, FALSE.

Remarks

Call this method to assign a popup menu to the ribbon element that has the given command ID.

Requirements

Header: afxRibbonPanel.h

See Also

Reference

CMFCRibbonPanel Class

Hierarchy Chart