CMFCRibbonBar::AddContextCategory

Creates and initializes a new context category for the ribbon bar.

CMFCRibbonCategory* AddContextCategory(
   LPCTSTR lpszName,
   LPCTSTR lpszContextName,
   UINT uiContextID,
   AFX_RibbonCategoryColor clrContext,
   UINT uiSmallImagesResID,
   UINT uiLargeImagesResID,
   CSize sizeSmallImage = CSize(16, 16),
   CSize sizeLargeImage = CSize(32, 32),
   CRuntimeClass* pRTI = NULL 
);

Parameters

• [in] lpszName
  Name of the category.

• [in] lpszContextName
  Name of the context category caption.

• [in] uiContextID
  Context ID.

• [in] clrContext
  Color of the context category caption.

• [in] uiSmallImagesResID
  Resource ID of the small image of a context category.

• [in] uiLargeImagesResID
  Resource ID of the large image of a context category.

• [in] sizeSmallImage
  Size of a small image.

• [in] sizeLargeImage
  Size of a large image.

• [in] pRTI
  Pointer to a runtime class.

Return Value

A pointer to the newly created category, or NULL if the CreateObject method of pRTI cannot create the specified category.

Remarks

Use this function to add a context category. Context categories are a special type of category that can be shown or hidden at runtime, depending on the current application context. For example, when the user selects an object, you can display special tabs with context categories which you use to change the specific selected object.

The color of a context category can be one of the following values:

• AFX_CategoryColor_None

• AFX_CategoryColor_Red

• AFX_CategoryColor_Orange

• AFX_CategoryColor_Yellow

• AFX_CategoryColor_Green

• AFX_CategoryColor_Blue

• AFX_CategoryColor_Indigo

• AFX_CategoryColor_Violet

Requirements

Header: afxribbonbar.h

See Also

Concepts

MFC Hierarchy Chart

Reference

CMFCRibbonBar Class

Change History