CMFCRibbonPanel::SetElementRTCByID

Adds a ribbon element that is specified by the provided runtime class information to the ribbon panel.

CMFCRibbonBaseElement* SetElementRTCByID(
    UINT uiCmdID,
    CRuntimeClass* pRTC 
);

Parameters

  • [in] uiCmdID
    Specifies the command ID of the ribbon element to add.

  • [in] [out] pRTC
    A pointer to the runtime class information associated with the ribbon element that is added to the ribbon panel.

Return Value

The ribbon element that was created by using the specified runtime class information.

Remarks

If you want to add a custom element (for example, a color button) to the ribbon panel, you must specify the custom element's runtime class information. The ribbon stores this information, creates the custom element, and replaces an existing element located by the specified command ID. It then returns a pointer to the newly created element.

Example

The following example shows how to use the SetElementRTCByID method:

// Load and add toolbar with standard buttons. This toolbar
// should display a custom color button with id ID_CHAR_COLOR:

pPanel->AddToolBar(IDR_MAINFRAME, IDB_MAINFRAME256);
CMFCRibbonColorButton* pColorButton =
    (CMFCRibbonColorButton*)pPanel->SetElementRTCByID(
    ID_CHAR_COLOR, RUNTIME_CLASS (CMFCRibbonColorButton));

// SetElementRTCByID sets runtime class and returns a pointer
// to the newly created custom button, which can be set up immediately:
pColorButton->EnableAutomaticButton(_T("Automatic"), RGB (0, 0, 0));

Requirements

Header: afxRibbonPanel.h

See Also

Reference

CMFCRibbonPanel Class

Hierarchy Chart