CMFCRibbonPanel, classe

Article
10/12/2023

Implémente un panneau qui contient un jeu d'éléments de ruban. Lorsque le panneau est dessiné, il affiche le plus d'éléments possible, selon la taille du panneau.

Pour plus d’informations, consultez le code source situé dans le dossier VC\atlmfc\src\mfc de votre installation de Visual Studio.

Syntaxe

class CMFCRibbonPanel : public CObject

Membres

Constructeurs protégés

Nom	Description
CMFCRibbonPanel ::CMFCRibbonPanel	Construit et initialise un objet `CMFCRibbonPanel`.

Méthodes publiques

Nom	Description
CMFCRibbonPanel ::Add	Ajoute un élément de ruban au panneau.
CMFCRibbonPanel ::AddSeparator	Ajoute un séparateur au panneau du ruban.
CMFCRibbonPanel ::AddToolBar	Ajoute une barre d’outils au panneau du ruban.
CMFCRibbonPanel ::FindByData
CMFCRibbonPanel ::FindByID	Retourne un élément identifié par un ID de commande spécifié.
CMFCRibbonPanel ::GetCaptionHeight
CMFCRibbonPanel ::GetCount	Retourne le nombre d’éléments dans le panneau du ruban.
CMFCRibbonPanel ::GetData	Retourne les données définies par l’utilisateur associées au panneau.
CMFCRibbonPanel ::GetDefaultButton
CMFCRibbonPanel ::GetDroppedDown
CMFCRibbonPanel ::GetElement	Retourne l’élément du ruban situé à un index spécifié.
CMFCRibbonPanel ::GetElements	Récupère tous les éléments contenus dans le panneau du ruban.
CMFCRibbonPanel ::GetElementsByID
CMFCRibbonPanel ::GetFocused	Retourne un élément qui a le focus.
CMFCRibbonPanel ::GetGalleryRect	Retourne un rectangle englobant de l’élément Gallery.
CMFCRibbonPanel ::GetHighlighted
CMFCRibbonPanel ::GetIndex
CMFCRibbonPanel ::GetItemIDsList
CMFCRibbonPanel ::GetName
CMFCRibbonPanel ::GetParentButton
CMFCRibbonPanel ::GetParentCategory	Retourne la catégorie parente du panneau du ruban.
CMFCRibbonPanel ::GetParentMenuBar
CMFCRibbonPanel ::GetPreferedMenuLocation
CMFCRibbonPanel ::GetPressed
CMFCRibbonPanel ::GetRect
CMFCRibbonPanel ::GetVisibleElements	Obtient un tableau d’éléments visibles.
CMFCRibbonPanel ::HasElement
CMFCRibbonPanel ::HitTest
CMFCRibbonPanel ::HitTestEx
CMFCRibbonPanel ::Insert	Insère un élément de ruban à la position donnée.
CMFCRibbonPanel ::InsertSeparator	Insère un séparateur à la position donnée.
CMFCRibbonPanel ::IsCenterColumnVert	Spécifie si tous les éléments du panneau doivent être centrés (alignés) verticalement, par colonne.
CMFCRibbonPanel ::IsCollapsed
CMFCRibbonPanel ::IsHighlighted
CMFCRibbonPanel ::IsJustifyColumns	Spécifie si toutes les colonnes du panneau ont la même largeur.
CMFCRibbonPanel ::IsMainPanel
CMFCRibbonPanel ::IsMenuMode
CMFCRibbonPanel ::MakeGalleryItemVisible	Fait défiler la galerie pour rendre l’élément ruban spécifié visible.
CMFCRibbonPanel ::OnKey
CMFCRibbonPanel ::RecalcWidths
CMFCRibbonPanel ::Remove	Supprime et supprime éventuellement un élément situé à l’index spécifié.
CMFCRibbonPanel ::RemoveAll	Supprime tous les éléments du panneau du ruban.
CMFCRibbonPanel ::Replace	Remplace un élément par un autre en fonction de leurs valeurs d’index respectives.
CMFCRibbonPanel ::ReplaceByID	Remplace un élément par un autre en fonction d’un ID de commande spécifié.
CMFCRibbonPanel ::SetCenterColumnVert	Commande le panneau d’aligner les éléments verticalement, par colonne.
CMFCRibbonPanel ::SetData	Associe les données définies par l’utilisateur au panneau du ruban.
CMFCRibbonPanel ::SetElementMenu	Affecte un menu contextuel à l’élément qui a l’ID de commande donné.
CMFCRibbonPanel ::SetElementRTC	Ajoute un élément de ruban spécifié par les informations de classe runtime fournies dans le panneau du ruban.
CMFCRibbonPanel ::SetElementRTCByID	Ajoute un élément de ruban spécifié par les informations de classe runtime fournies dans le panneau du ruban.
CMFCRibbonPanel ::SetFocused	Définit le focus sur l’élément Ribbon spécifié.
CMFCRibbonPanel ::SetJustifyColumns	Active ou désactive la justification des colonnes.
CMFCRibbonPanel ::SetKeys	Définit le raccourci clavier qui affiche le panneau du ruban.
CMFCRibbonPanel ::ShowPopup

Notes

Les panneaux du ruban sont des regroupements logiques de tâches associées que vous créez dans les catégories de ruban. À mesure que la taille du ruban change, la disposition du panneau s’ajuste automatiquement pour afficher autant d’éléments que possible.

Vous pouvez obtenir un panneau de ruban contenu dans une catégorie de ruban en appelant la méthode CMFCRibbonCategory ::GetPanel .

Exemple

L’exemple suivant montre comment configurer un CMFCRibbonPanel objet à l’aide de différentes méthodes dans la CMFCRibbonPanel classe. L’exemple montre comment définir le raccourci clavier qui affiche le panneau du ruban, aligner les éléments dans le panneau verticalement par colonne et activer la justification de colonne. Cet extrait de code fait partie de l’exemple de démonstration MS Office 2007.

// CMFCRibbonCategory* pCategory
// CMFCToolBarImages m_PanelImages
CMFCRibbonPanel *pPanelClipboard = pCategory->AddPanel(_T("Clipboard"), m_PanelImages.ExtractIcon(1));
pPanelClipboard->SetKeys(_T("zc"));
pPanelClipboard->SetCenterColumnVert();
pPanelClipboard->SetJustifyColumns();

Hiérarchie d'héritage

CObject

CMFCRibbonPanel

Spécifications

En-tête : afxRibbonPanel.h

CMFCRibbonPanel ::Add

Ajoute l’élément de ruban spécifié au tableau d’éléments du ruban contenus dans le panneau du ruban.

virtual void Add(CMFCRibbonBaseElement* pElem);

Paramètres

pElem
[in, out] Pointeur vers un élément du ruban.

Notes

CMFCRibbonPanel ::AddSeparator

Ajoute un séparateur au panneau du ruban.

virtual void AddSeparator();

Notes

Appelez cette méthode pour ajouter un séparateur au panneau du ruban. Le séparateur est ajouté en regard de l’élément du ruban qui a été ajouté par l’appel précédent à CMFCRibbonPanel ::Add. Pour insérer un séparateur à une position donnée, appelez CMFCRibbonPanel ::InsertSeparator.

CMFCRibbonPanel ::AddToolBar

Ajoute une barre d’outils au panneau du ruban.

CMFCRibbonButtonsGroup* AddToolBar(
UINT uiToolbarResID,
UINT uiColdResID = 0,
UINT uiHotResID = 0,
UINT uiDisabledResID = 0);

Paramètres

uiToolbarResID
[in] Spécifie l’ID de ressource de la barre d’outils à ajouter.

uiColdResID
[in] Spécifie l’ID de ressource des images froides de la barre d’outils.

uiHotResID
[in] Spécifie l’ID de ressource des images chaudes de la barre d’outils.

uiDisabledResID
[in] Spécifie l’ID de ressource des images désactivées de la barre d’outils.

Valeur de retour

Appelez cette méthode pour ajouter une barre d’outils au panneau du ruban. La barre d’outils est ajoutée en regard de l’élément du ruban ajouté par l’appel précédent à CMFCRibbonPanel ::Add.

Notes

Pour plus d’informations sur les barres d’outils, les images chaudes, les images froides et les images désactivées, consultez CMFCToolBar, classe.

CMFCRibbonPanel ::CMFCRibbonPanel

Construit et initialise un objet CMFCRibbonPanel .

CMFCRibbonPanel(
LPCTSTR lpszName = NULL,
HICON hIcon = NULL);

CMFCRibbonPanel(CMFCRibbonGallery* pPaletteButton);

Paramètres

lpszName
[in] Nom du panneau du ruban.

hIcon
[in] Gérez l’icône du bouton par défaut pour le panneau du ruban.

pPaletteButton
[in] Pointeur vers une galerie de rubans pour le panneau du ruban.

CMFCRibbonPanel ::FindByData

Récupère l’élément du ruban associé aux données spécifiées.

CMFCRibbonBaseElement* FindByData(DWORD_PTR dwData) const;

Paramètres

dwData
[in] Données associées à un élément de ruban.

Valeur de retour

Pointeur vers un élément du ruban si la méthode a réussi ; sinon NULL.

Notes

CMFCRibbonPanel ::FindByID

Récupère l’élément du ruban identifié par l’ID de commande spécifié.

CMFCRibbonBaseElement* FindByID(UINT uiCmdID) const;

Paramètres

uiCmdID
[in] ID de commande d’un élément de ruban.

Valeur de retour

Élément du ruban identifié par l’ID de commande spécifié ; sinon NULL si aucun élément de ruban n’est identifié avec l’ID de commande spécifié.

CMFCRibbonPanel ::GetCaptionHeight

Récupère la hauteur d’une légende pour le panneau du ruban.

int GetCaptionHeight() const;

Valeur de retour

Hauteur, en pixels, d’une légende pour le panneau du ruban.

Notes

CMFCRibbonPanel ::GetCount

Récupère le nombre d’éléments du ruban contenus dans le panneau du ruban.

int GetCount() const;

Valeur de retour

Nombre d’éléments de ruban contenus dans le panneau du ruban.

CMFCRibbonPanel ::GetData

Retourne les données définies par l’utilisateur associées au panneau.

DWORD_PTR GetData() const;

Valeur de retour

Données définies par l’utilisateur associées au panneau.

CMFCRibbonPanel ::GetDefaultButton

Récupère le bouton par défaut pour le panneau du ruban.

CMFCRibbonButton& GetDefaultButton();

Valeur de retour

Bouton par défaut pour le panneau du ruban.

Notes

Le bouton par défaut s’affiche lorsqu’un panneau de ruban n’a pas suffisamment d’espace pour afficher ses éléments de ruban.

CMFCRibbonPanel ::GetDroppedDown

Récupère un pointeur vers un élément de ruban si son menu contextuel est supprimé.

CMFCRibbonBaseElement* GetDroppedDown() const;

Valeur de retour

Pointeur vers l’élément du ruban dont le menu contextuel est déroulant ; sinon, NULL si aucun élément du ruban n’a son menu contextuel déroulant.

Notes

Seuls les éléments du ruban contenus dans le panneau du ruban sont testés.

CMFCRibbonPanel ::GetElement

Retourne l’élément du ruban situé à un index spécifié.

CMFCRibbonBaseElement* GetElement(int nIndex) const;

Paramètres

nIndex
[in] Spécifie l’index de base zéro de l’élément à récupérer.

Valeur de retour

Pointeur valide vers l’élément du ruban de base situé à la position nIndex dans le panneau du ruban, ou NULL s’il n’existe aucun élément à l’index spécifié.

CMFCRibbonPanel ::GetElements

Récupère tous les éléments du ruban contenus dans le panneau du ruban.

void GetElements(CArray<CMFCRibbonBaseElement*, CMFCRibbonBaseElement*>& arElements);

Paramètres

arElements
[out] Tableau à remplir avec tous les éléments du ruban contenus dans le panneau du ruban.

Notes

CMFCRibbonPanel ::GetElementsByID

Ajoute des éléments du ruban qui ont l’ID de commande spécifié au tableau spécifié.

void GetElementsByID(
UINT uiCmdID,
CArray<CMFCRibbonBaseElement*, CMFCRibbonBaseElement*>& arElements);

Paramètres

uiCmdID
[in] ID de commande d’un élément de ruban.

arElements
[in] Tableau d’éléments du ruban.

Notes

Seuls les éléments du ruban contenus dans le panneau du ruban sont testés.

CMFCRibbonPanel ::GetHighlighted

Récupère l’élément du ruban mis en surbrillance dans le panneau du ruban.

CMFCRibbonBaseElement* GetHighlighted() const;

Valeur de retour

Pointeur vers l’élément du ruban mis en surbrillance dans le panneau du ruban.

Notes

CMFCRibbonPanel ::GetIndex

Récupère l’index de base zéro de l’élément de ruban spécifié à partir du tableau d’éléments du ruban contenus dans le panneau du ruban.

virtual int GetIndex(CMFCRibbonBaseElement* pElem) const;

Paramètres

pElem
[in] Pointeur vers un élément du ruban.

Valeur de retour

Index de base zéro de l’élément de ruban spécifié si la méthode a réussi ; sinon -1.

Notes

CMFCRibbonPanel ::GetItemIDsList

Récupère les ID de commande pour tous les éléments du ruban dans le panneau du ruban.

void GetItemIDsList(CList<UINT, UINT>& lstItems) const;

Paramètres

lstItems
[out] Liste des ID de commande pour les éléments du ruban contenus dans le panneau du ruban.

Notes

CMFCRibbonPanel ::GetName

Récupère le nom du panneau du ruban.

LPCTSTR GetName() const;

Valeur de retour

Nom du panneau du ruban.

Notes

CMFCRibbonPanel ::GetParentButton

CMFCRibbonBaseElement* GetParentButton() const;

Valeur de retour

Notes

CMFCRibbonPanel ::GetParentCategory

Retourne la catégorie parente du panneau du ruban.

CMFCRibbonCategory* GetParentCategory() const;

Valeur de retour

Pointeur vers la catégorie de ruban qui contient ce panneau de ruban.

CMFCRibbonPanel ::GetParentMenuBar

CMFCRibbonPanelMenuBar* GetParentMenuBar() const;

Valeur de retour

Notes

CMFCRibbonPanel ::GetPreferedMenuLocation

Récupère le rectangle d’affichage préféré pour le menu contextuel du panneau du ruban.

virtual BOOL GetPreferedMenuLocation(CRect& rect);

Paramètres

rect
[out] Ce paramètre n’est pas utilisé.

Valeur de retour

Retourne toujours FALSE.

Notes

Cette méthode retourne toujours FALSE. Remplacez cette méthode pour récupérer le rectangle d’affichage préféré pour le menu contextuel du panneau du ruban.

CMFCRibbonPanel ::GetPressed

Récupère un pointeur vers un élément de ruban dans le panneau du ruban si l’utilisateur appuie actuellement dessus.

CMFCRibbonBaseElement* GetPressed() const;

Valeur de retour

Pointeur vers un élément de ruban si l’utilisateur l’appuie actuellement ; sinon NULL.

Notes

CMFCRibbonPanel ::GetRect

Récupère le rectangle d’affichage du panneau du ruban.

const CRect& GetRect() const;

Valeur de retour

Rectangle d’affichage du panneau du ruban.

Notes

CMFCRibbonPanel ::HasElement

Indique si le panneau du ruban contient l’élément de ruban spécifié.

BOOL HasElement(const CMFCRibbonBaseElement* pElem) const;

Paramètres

pElem
[in] Pointeur vers un élément du ruban.

Valeur de retour

TRUE si le panneau du ruban contient l’élément de ruban spécifié ; sinon FALSE.

Notes

CMFCRibbonPanel ::Highlight

Définit la couleur de surbrillance du panneau de ruban sélectionné et de l’élément de ruban spécifié par le point.

virtual void Highlight(
BOOL bHighlight,
CPoint point);

Paramètres

bHighlight
[in] TRUE pour mettre en surbrillance le panneau du ruban ; FALSE pour afficher le panneau du ruban.

point
[in] Coordonnées x et y du pointeur, par rapport au coin supérieur gauche de la fenêtre.

Notes

CMFCRibbonPanel ::HitTest

Récupère un élément de ruban si le point spécifié se trouve dans celui-ci.

virtual CMFCRibbonBaseElement* HitTest(
CPoint point,
BOOL bCheckPanelCaption = FALSE);

Paramètres

point
[in] Coordonnées x et y du pointeur, par rapport au coin supérieur gauche de la fenêtre.

bCheckPanelCaption
[in] TRUE pour tester la légende du panneau du ruban ; sinon FALSE.

Valeur de retour

Pointeur vers un élément du ruban si le point spécifié se trouve dans celui-ci ; sinon NULL.

Notes

Seuls les éléments du ruban contenus dans le panneau du ruban sont testés.

CMFCRibbonPanel ::HitTestEx

Récupère l’index de base zéro de l’élément de ruban qui a le point spécifié situé dans celui-ci.

virtual int HitTestEx(CPoint point) const;

Paramètres

point
[in] Coordonnées x et y du pointeur, par rapport au coin supérieur gauche de la fenêtre.

Valeur de retour

Index de base zéro de l’élément de ruban qui a le point spécifié situé dans celui-ci ; sinon -1.

Notes

Seuls les éléments du ruban contenus dans le panneau du ruban sont testés.

CMFCRibbonPanel ::Insert

Insère l’élément de ruban spécifié à la position spécifiée dans le tableau d’éléments du ruban contenus dans le panneau du ruban.

virtual BOOL Insert(
CMFCRibbonBaseElement* pElem,
int nIndex);

Paramètres

pElem
[in, out] Pointeur vers un élément du ruban.

nIndex
[in] Valeur de base zéro, comprise entre -1 et le nombre d’éléments du ruban contenus dans le tableau.

Valeur de retour

TRUE si l’élément du ruban a été inséré avec succès ; sinon FALSE.

Notes

Si la valeur de nIndex est -1 ou si nIndex est égal au nombre d’éléments du ruban dans le tableau, l’élément de ruban spécifié est ajouté à la fin du tableau. Si la valeur de nIndex est hors plage, la méthode échoue.

CMFCRibbonPanel ::InsertSeparator

Insère un séparateur à la position donnée.

virtual BOOL InsertSeparator(int nIndex);

Paramètres

nIndex
[in] Spécifie l’index de base zéro où le séparateur est inséré.

Valeur de retour

TRUE si le séparateur a été inséré avec succès ; sinon, FALSE.

Notes

Appelez cette méthode pour insérer un séparateur à la position spécifiée par nIndex. Pour insérer un séparateur en regard de l’élément de ruban le plus récemment ajouté, appelez CMFCRibbonPanel ::AddSeparator.

CMFCRibbonPanel ::IsCenterColumnVert

Indique si les positions verticales des éléments du ruban sont centrées dans leur rectangle d’affichage.

BOOL IsCenterColumnVert() const;

Valeur de retour

TRUE si les positions verticales des éléments du ruban sont centrées dans leur rectangle d’affichage ; sinon FALSE.

CMFCRibbonPanel ::IsCollapsed

Indique si la taille d’affichage du panneau du ruban est réduite dans le sens horizontal.

BOOL IsCollapsed() const;

Valeur de retour

TRUE si la taille d’affichage du panneau du ruban est réduite dans la direction horizontale ; sinon FALSE.

Notes

Lorsqu’un panneau de ruban est réduit, il affiche uniquement son bouton par défaut, son nom et une flèche déroulante.

CMFCRibbonPanel ::IsHighlighted

Indique si l’affichage du panneau du ruban est mis en surbrillance.

BOOL IsHighlighted() const;

Valeur de retour

TRUE si l’affichage du panneau du ruban est mis en surbrillance ; sinon FALSE.

Notes

L’affichage d’un panneau de ruban est mis en surbrillance lorsque le pointeur est sur celui-ci.

CMFCRibbonPanel ::IsJustifyColumns

Indique si les dimensions d’affichage des éléments du ruban qui se trouvent dans la même colonne dans le panneau du ruban sont définies sur la même largeur.

BOOL IsJustifyColumns() const;

Valeur de retour

TRUE si les dimensions d’affichage des éléments du ruban qui se trouvent dans la même colonne dans le panneau du ruban sont définies sur la même largeur ; sinon FALSE.

CMFCRibbonPanel ::IsMainPanel

Indique si le panneau du ruban est le panneau principal du ruban.

virtual BOOL IsMainPanel() const;

Valeur de retour

Retourne toujours FALSE.

Notes

Cette méthode retourne toujours FALSE. Remplacez cette méthode pour indiquer si le panneau du ruban est le panneau principal du ruban.

Le panneau du ruban principal s’affiche lorsque l’utilisateur sélectionne le bouton de l’application.

CMFCRibbonPanel ::IsMenuMode

BOOL IsMenuMode() const;

Valeur de retour

Notes

CMFCRibbonPanel ::OnKey

virtual BOOL OnKey(UINT nChar);

Paramètres

[in] nChar

Valeur de retour

Notes

CMFCRibbonPanel ::RecalcWidths

Recalcule la largeur de chaque configuration de disposition d’affichage pour le panneau du ruban.

virtual void RecalcWidths(
CDC* pDC,
int nHeight);

Paramètres

pDC
[in] Pointeur vers un contexte d’appareil pour le panneau du ruban.

nHeight
[in] Hauteur du panneau du ruban.

Notes

Un panneau de ruban modifie sa configuration de disposition au fur et à mesure que la largeur disponible change.

CMFCRibbonPanel ::Remove

Supprime et supprime éventuellement un élément situé à l’index spécifié.

BOOL Remove(
int nIndex,
BOOL bDelete = TRUE);

Paramètres

nIndex
[in] Spécifie l’index de base zéro de l’élément supprimé du panneau du ruban.

bDelete
[in] TRUE pour supprimer l’élément en cours de suppression ; sinon, FALSE.

Valeur de retour

TRUE si l’élément a été supprimé et supprimé (si bDelete a la valeur TRUE) ; FALSE si l’élément n’a pas été supprimé ou s’il n’existe aucun élément de ruban situé à nIndex.

Notes

Appelez cette méthode pour supprimer un élément du panneau du ruban.

CMFCRibbonPanel ::RemoveAll

Supprime tous les éléments du ruban du panneau du ruban.

void RemoveAll();

Notes

Tous les éléments du ruban sont supprimés du panneau du ruban et détruits.

CMFCRibbonPanel ::Replace

Remplace un élément par un autre en fonction de sa valeur d’index.

BOOL Replace(
int nIndex,
CMFCRibbonBaseElement* pElem);

Paramètres

nIndex
[in] Spécifie l’index de base zéro de l’élément à remplacer.

pElem
[in, out] Pointeur valide vers l’élément qui remplace l’élément d’origine.

Valeur de retour

TRUE si l’élément de ruban d’origine a été remplacé avec succès par le nouvel élément du ruban ; FALSE si l’élément du ruban n’a pas été remplacé ou s’il n’existe aucun élément à l’index spécifié.

Notes

Pour remplacer un élément du ruban par ID de commande, appelez CMFCRibbonPanel ::ReplaceByID.

CMFCRibbonPanel ::ReplaceByID

Remplace un élément par un autre en fonction d’un ID de commande spécifié.

BOOL ReplaceByID(
UINT uiCmdID,
CMFCRibbonBaseElement* pElem);

Paramètres

uiCmdID
[in] Spécifie l’ID de commande de l’élément à remplacer.

pElem
[in, out] Pointeur valide vers l’élément qui remplacera l’élément d’origine.

Valeur de retour

TRUE si l’élément de ruban d’origine a été remplacé avec succès par le nouvel élément du ruban ; FALSE si l’élément du ruban n’a pas été remplacé ou s’il n’existe aucun élément avec l’ID de commande spécifié.

Notes

Pour remplacer un élément de ruban en fonction de la position, appelez CMFCRibbonPanel ::Replace.

CMFCRibbonPanel ::SetCenterColumnVert

Active ou désactive le centrement des positions verticales des éléments du ruban dans leur rectangle d’affichage.

void SetCenterColumnVert(BOOL bSet = TRUE);

Paramètres

bSet
[in] TRUE pour centrer les positions verticales des éléments du ruban dans leur rectangle d’affichage ; FALSE pour désactiver cette fonctionnalité.

Notes

CMFCRibbonPanel ::SetData

Associe les données définies par l’utilisateur au panneau du ruban.

void SetData(DWORD_PTR dwData);

Paramètres

dwData
[in] Spécifie les données définies par l’utilisateur à définir.

Notes

Appelez cette méthode pour associer des données définies par l’utilisateur au panneau du ruban.

CMFCRibbonPanel ::SetElementMenu

Affecte un menu contextuel à l’élément qui a l’ID de commande donné.

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

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

Paramètres

uiCmdID
[in] Spécifie l’ID de commande de l’élément du ruban où le menu est ajouté.

hMenu
[in] Spécifie le handle du menu Windows à ajouter au panneau du ruban.

bIsDefautCommand
[in] TRUE pour spécifier que la commande associée à l’élément du ruban doit être exécutée si l’élément du ruban est cliqué. Dans ce cas, le menu est ouvert uniquement lorsque l’utilisateur clique sur la flèche en regard de l’élément du ruban. FALSE pour spécifier que la commande associée à l’élément du ruban ne doit pas être exécutée si l’élément du ruban est cliqué. Dans ce cas, le menu contextuel s’affiche, quel que soit l’emplacement où l’utilisateur clique sur l’élément.

bRightAlign
[in] TRUE pour spécifier que le menu contextuel est aligné à droite ; sinon, FALSE.

uiMenuResID
[in] Spécifie l’ID de ressource du menu à ajouter au panneau du ruban.

Valeur de retour

TRUE si le menu a été affecté à l’élément du ruban ; sinon, FALSE.

Notes

Appelez cette méthode pour affecter un menu contextuel à l’élément du ruban qui a l’ID de commande donné.

CMFCRibbonPanel ::SetElementRTC

Ajoute l’élément de ruban spécifié par les informations de classe runtime fournies dans le panneau du ruban.

CMFCRibbonBaseElement* SetElementRTC(
int nIndex,
CRuntimeClass* pRTC);

Paramètres

nIndex
[in] Spécifie l’index de base zéro de l’élément de ruban à ajouter.

pRTC
[in, out] Pointeur vers les informations de classe runtime pour l’élément du ruban ajouté au panneau du ruban.

Valeur de retour

Élément du ruban créé à l’aide des informations de classe runtime spécifiées.

Notes

Si vous souhaitez ajouter un élément personnalisé (par exemple, un bouton couleur) au panneau du ruban, vous devez spécifier les informations de classe runtime de l’élément personnalisé. Le ruban stocke ces informations, crée l’élément personnalisé et remplace un élément existant situé (identifié par) l’ID de commande spécifié. Le ruban retourne ensuite un pointeur vers l’élément nouvellement créé.

CMFCRibbonPanel ::SetElementRTCByID

Ajoute un élément de ruban spécifié par les informations de classe runtime fournies dans le panneau du ruban.

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

Paramètres

uiCmdID
[in] Spécifie l’ID de commande de l’élément de ruban à ajouter.

pRTC
[in, out] Pointeur vers les informations de classe runtime associées à l’élément du ruban ajouté au panneau du ruban.

Valeur de retour

Élément du ruban créé à l’aide des informations de classe runtime spécifiées.

Notes

Si vous souhaitez ajouter un élément personnalisé (par exemple, un bouton couleur) au panneau du ruban, vous devez spécifier les informations de classe runtime de l’élément personnalisé. Le ruban stocke ces informations, crée l’élément personnalisé et remplace un élément existant situé par l’ID de commande spécifié. Il retourne ensuite un pointeur vers l’élément nouvellement créé.

Exemple

L’exemple suivant montre comment utiliser la SetElementRTCByID méthode :

// 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));

CMFCRibbonPanel ::SetJustifyColumns

Active ou désactive l’ajustement de la largeur des éléments du ruban dans la même colonne.

void SetJustifyColumns(BOOL bSet = TRUE);

Paramètres

bSet
[in] TRUE pour ajuster la largeur des éléments du ruban dans la même colonne à la largeur de l’élément de ruban le plus grand dans la colonne ; FALSE pour désactiver cet ajustement de largeur.

Notes

Lorsque cette fonctionnalité est activée dans un panneau de ruban, les largeurs des éléments du ruban de la même colonne sont ajustées à la largeur de l’élément de ruban le plus grand dans la même colonne.

CMFCRibbonPanel ::SetKeys

Définit l’info-bulle pour le bouton par défaut du panneau du ruban.

void SetKeys(LPCTSTR lpszKeys);

Paramètres

lpszKeys
[in] Info-bulle pour le bouton par défaut du panneau du ruban.

Notes

Le bouton par défaut s’affiche lorsqu’un panneau de ruban n’a pas suffisamment d’espace pour afficher ses éléments de ruban.

CMFCRibbonPanel ::ShowPopup

Crée et affiche un menu contextuel pour le panneau du ruban.

CMFCRibbonPanelMenu* ShowPopup(CMFCRibbonDefaultPanelButton* pButton = NULL);

Paramètres

pButton
[in] Pointeur vers le bouton par défaut du panneau du ruban.

Valeur de retour

Pointeur vers le menu contextuel du panneau du ruban si la méthode a réussi ; sinon NULL.

Notes

Le menu contextuel du panneau du ruban est disponible uniquement lorsque l’affichage du panneau du ruban est réduit.

CMFCRibbonPanel ::SetFocused

Définit le focus sur l’élément Ribbon spécifié.

void SetFocused(CMFCRibbonBaseElement* pNewFocus);

Paramètres

pNewFocus
Pointeur vers un élément Ribbon qui reçoit le focus.

Notes

CMFCRibbonPanel ::MakeGalleryItemVisible

Fait défiler la galerie pour rendre l’élément ruban spécifié visible.

void MakeGalleryItemVisible(CMFCRibbonBaseElement* pItem);

Paramètres

pItem
Pointeur vers un élément Ribbon à afficher.

Notes

CMFCRibbonPanel ::IsWindows7Look

Indique si le ruban parent a l’apparence de Windows 7 (petit bouton d’application rectangulaire).

BOOL IsWindows7Look() const;

Valeur de retour

TRUE si le ruban parent a l’apparence de Windows 7 ; sinon FALSE.

Notes

CMFCRibbonPanel ::GetVisibleElements

Récupère un tableau d’éléments visibles.

void GetVisibleElements(
CArray<CMFCRibbonBaseElement*,
CMFCRibbonBaseElement*>& arElements);

Paramètres

arElements
Lorsque la fonction est retournée, ce paramètre contient un tableau d’éléments visibles.

Notes

CMFCRibbonPanel ::GetGalleryRect

Retourne un rectangle englobant d’un élément Gallery.

CRect GetGalleryRect();

Valeur de retour

Taille et position de l’élément Gallery dans ce panneau.

Notes

CMFCRibbonPanel ::GetFocused

Retourne un élément qui a le focus.

CMFCRibbonBaseElement* GetFocused() const;

Valeur de retour

Pointeur vers un élément prioritaire ou NULL.

Notes

Voir aussi

Graphique hiérarchique
Classes
CObject, classe
CMFCRibbonCategory, classe
CMFCRibbonBaseElement, classe

Partager via

CMFCRibbonPanel, classe

Syntaxe

Membres

Constructeurs protégés

Méthodes publiques

Notes

Exemple

Hiérarchie d'héritage

Spécifications

CMFCRibbonPanel ::Add

Paramètres

Notes

CMFCRibbonPanel ::AddSeparator

Notes

CMFCRibbonPanel ::AddToolBar

Paramètres

Valeur de retour

Notes

CMFCRibbonPanel ::CMFCRibbonPanel

Paramètres

CMFCRibbonPanel ::FindByData

Paramètres

Valeur de retour

Notes

CMFCRibbonPanel ::FindByID

Paramètres

Valeur de retour

CMFCRibbonPanel ::GetCaptionHeight

Valeur de retour

Notes

CMFCRibbonPanel ::GetCount

Valeur de retour

CMFCRibbonPanel ::GetData

Valeur de retour

CMFCRibbonPanel ::GetDefaultButton

Valeur de retour

Notes

CMFCRibbonPanel ::GetDroppedDown

Valeur de retour

Notes

CMFCRibbonPanel ::GetElement

Paramètres

Valeur de retour

CMFCRibbonPanel ::GetElements

Paramètres

Notes

CMFCRibbonPanel ::GetElementsByID

Paramètres

Notes

CMFCRibbonPanel ::GetHighlighted

Valeur de retour

Notes

CMFCRibbonPanel ::GetIndex

Paramètres

Valeur de retour

Notes

CMFCRibbonPanel ::GetItemIDsList

Paramètres

Notes

CMFCRibbonPanel ::GetName

Valeur de retour

Notes

CMFCRibbonPanel ::GetParentButton

Valeur de retour

Notes

CMFCRibbonPanel ::GetParentCategory

Valeur de retour

CMFCRibbonPanel ::GetParentMenuBar

Valeur de retour

Notes

CMFCRibbonPanel ::GetPreferedMenuLocation

Paramètres

Valeur de retour

Notes

CMFCRibbonPanel ::GetPressed

Valeur de retour

Notes

CMFCRibbonPanel ::GetRect

Valeur de retour