CMFCRibbonCategory::AddPanel

  • Article

Creates a ribbon panel for the ribbon category.

CMFCRibbonPanel* AddPanel(
   LPCTSTR lpszPanelName,
   HICON hIcon = 0,
   CRuntimeClass* pRTI = NULL 
);

Parameters

  • [in] lpszPanelName
    Pointer to the name of the new ribbon panel.

  • [in] hIcon
    Handle to the default icon for the new ribbon panel.

  • [in] pRTI
    Pointer to runtime class information for a custom ribbon panel.

Return Value

Pointer to the new ribbon panel if the method was successful; otherwise NULL if the panel was not created.

Remarks

If you want to create a custom ribbon panel, you must specify its runtime class information in pRTI. The custom ribbon panel class must be derived from the CMFCRibbonPanel class.

The default icon for the ribbon panel is displayed when there is insufficient space to display the ribbon elements.

Example

The following example demonstrates how to use the AddPanel method in the CMFCRibbonCategory class.

// Create "Favorites" panel:
    strTemp.LoadString(IDS_RIBBON_FAVORITES);
    // CMFCRibbonCategory* pCategoryCustom
    CMFCRibbonPanel* pPanelFavorites = pCategoryCustom->AddPanel(strTemp, 
        m_PanelImages.ExtractIcon(15));

Requirements

Header: afxribboncategory.h

See Also

Concepts

MFC Hierarchy Chart

Reference

CMFCRibbonCategory Class

Change History

Date

History

Reason

October 2008

Updated whole topic.

Information enhancement.