La classe `CMFCRibbonBar`

Article
10/12/2023

La classe CMFCRibbonBar implémente une barre de ruban similaire à celle utilisée dans Office 2007.

Pour plus d’informations, consultez le code source situé dans le mfc dossier de votre installation de Visual Studio. Par exemple, %ProgramFiles(x86)%\Microsoft Visual Studio\2019\Enterprise\VC\Tools\MSVC\14.29.30133\atlmfc\src\mfc

Syntaxe

class CMFCRibbonBar : public CPane

Membres

Constructeurs publics

Nom	Description
`CMFCRibbonBar::CMFCRibbonBar`	Constructeur par défaut.

Méthodes publiques

Nom	Description
`CMFCRibbonBar::ActivateContextCategory`	Active une catégorie de contexte déjà visible.
`CMFCRibbonBar::AddCategory`	Ajoute une nouvelle catégorie de ruban au ruban.
`CMFCRibbonBar::AddContextCategory`	Ajoute une catégorie de contexte.
`CMFCRibbonBar::AddMainCategory`	Ajoute une nouvelle catégorie de ruban principale.
`CMFCRibbonBar::AddPrintPreviewCategory`
`CMFCRibbonBar::AddQATOnlyCategory`
`CMFCRibbonBar::AddToTabs`	Ajoute un élément de ruban à droite d'une barre de ruban.
`CMFCRibbonBar::CreateEx`	Crée une barre de contrôle et l’attache à l’objet `CPane` . (Substitue `CPane::CreateEx`.)
`CMFCRibbonBar::Create`	Crée un contrôle de barre de ruban et l'attache à une barre de ruban.
`CMFCRibbonBar::DeactivateKeyboardFocus`
`CMFCRibbonBar::DrawMenuImage`
`CMFCRibbonBar::DWMCompositionChanged`
`CMFCRibbonBar::EnableKeyTips`	Active ou désactive les touches d'accès pour le contrôle de ruban.
`CMFCRibbonBar::EnablePrintPreview`	Activez l’onglet Aperçu avant impression .
`CMFCRibbonBar::EnableToolTips`	Active ou désactive les descriptions d'info-bulles sur la barre du ruban.
`CMFCRibbonBar::FindByData`	Recherche un élément de ruban à partir des données spécifiées par un utilisateur.
`CMFCRibbonBar::FindByID`	Recherche un élément de ruban qui a l’ID de commande spécifié.
`CMFCRibbonBar::FindCategoryIndexByData`	Recherche l'index de la catégorie de ruban qui contient les données définies par l'utilisateur.
`CMFCRibbonBar::ForceRecalcLayout`
`CMFCRibbonBar::GetActiveCategory`	Obtient un pointeur vers une catégorie active.
`CMFCRibbonBar::GetCaptionHeight`	Retourne la hauteur de légende. (Substitue `CBasePane::GetCaptionHeight`.)
`CMFCRibbonBar::GetCategory`	Obtient le pointeur désignant une catégorie située dans un index spécifié.
`CMFCRibbonBar::GetCategoryCount`	Obtient le nombre de catégories de ruban présentes dans la barre du ruban.
`CMFCRibbonBar::GetCategoryHeight`
`CMFCRibbonBar::GetCategoryIndex`	Retourne l'index d'une catégorie de ruban.
`CMFCRibbonBar::GetContextName`	Récupère le nom de la légende de catégorie de contexte que vous spécifiez à l'aide d'un ID.
`CMFCRibbonBar::GetDroppedDown`
`CMFCRibbonBar::GetElementsByID`	Obtient un tableau qui contient les pointeurs vers tous les éléments de ruban qui ont l'ID spécifié.
`CMFCRibbonBar::GetApplicationButton`	Obtient un pointeur vers un bouton du ruban.
`CMFCRibbonBar::GetFocused`	Retourne un élément qui a le focus.
`CMFCRibbonBar::GetHideFlags`
`CMFCRibbonBar::GetItemIDsList`
`CMFCRibbonBar::GetKeyboardNavigationLevel`
`CMFCRibbonBar::GetKeyboardNavLevelCurrent`
`CMFCRibbonBar::GetKeyboardNavLevelParent`
`CMFCRibbonBar::GetMainCategory`	Retourne un pointeur vers la catégorie de ruban actuellement sélectionnée.
`CMFCRibbonBar::GetQATCommandsLocation`
`CMFCRibbonBar::GetQATDroppedDown`
`CMFCRibbonBar::GetQuickAccessCommands`	Remplit une liste qui contient les ID de commande de tous les éléments qui figurent sur la barre d'outils Accès rapide.
`CMFCRibbonBar::GetQuickAccessToolbarLocation`
`CMFCRibbonBar::GetTabTrancateRatio`
`CMFCRibbonBar::GetTooltipFixedWidthLargeImage`
`CMFCRibbonBar::GetTooltipFixedWidthRegular`
`CMFCRibbonBar::GetVisibleCategoryCount`
`CMFCRibbonBar::HideAllContextCategories`	Masque toutes les catégories actives et visibles.
`CMFCRibbonBar::HideKeyTips`
`CMFCRibbonBar::HitTest`	Recherche un pointeur vers l'élément de ruban qui se trouve au point spécifié dans les coordonnées clientes de la barre du ruban.
`CMFCRibbonBar::IsKeyTipEnabled`	Détermine si les touches d'accès sont activées.
`CMFCRibbonBar::IsMainRibbonBar`
`CMFCRibbonBar::IsPrintPreviewEnabled`	Détermine si l’onglet Aperçu avant impression est activé.
`CMFCRibbonBar::IsQATEmpty`
`CMFCRibbonBar::IsQuickAccessToolbarOnTop`	Spécifie si la barre d'outils Accès rapide se trouve au-dessus de la barre du ruban.
`CMFCRibbonBar::IsReplaceFrameCaption`	Détermine si la barre du ruban remplace la légende du cadre principal ou si elle est ajoutée en dessous de celle-ci.
`CMFCRibbonBar::IsShowGroupBorder`
`CMFCRibbonBar::IsToolTipDescrEnabled`	Détermine si les descriptions d'info-bulles sont activées.
`CMFCRibbonBar::IsToolTipEnabled`	Détermine si les info-bulles sont activées pour la barre du ruban.
`CMFCRibbonBar::IsTransparentCaption`
`CMFCRibbonBar::IsWindows7Look`	Indique si le ruban a le style Windows 7 (bouton d'application petit et rectangulaire).
`CMFCRibbonBar::LoadFromResource`	Surcharge. Charge une barre de ruban à partir des ressources d'application.
`CMFCRibbonBar::OnClickButton`
`CMFCRibbonBar::OnEditContextMenu`
`CMFCRibbonBar::OnRTLChanged`	(Substitue `CPane::OnRTLChanged`.)
`CMFCRibbonBar::OnSetAccData`	(Substitue `CBasePane::OnSetAccData`.)
`CMFCRibbonBar::OnShowRibbonContextMenu`
`CMFCRibbonBar::OnShowRibbonQATMenu`
`CMFCRibbonBar::OnSysKeyDown`
`CMFCRibbonBar::OnSysKeyUp`
`CMFCRibbonBar::PopTooltip`
`CMFCRibbonBar::PreTranslateMessage`	(Substitue `CBasePane::PreTranslateMessage`.)
`CMFCRibbonBar::RecalcLayout`	(Substitue `CPane::RecalcLayout`.)
`CMFCRibbonBar::RemoveAllCategories`	Supprime toutes les catégories de ruban de la barre du ruban.
`CMFCRibbonBar::RemoveAllFromTabs`	Supprime tous les éléments de ruban de la zone d'onglet.
`CMFCRibbonBar::RemoveCategory`	Supprime la catégorie de ruban qui se trouve dans l'index spécifié.
`CMFCRibbonBar::SaveToXMLBuffer`	Enregistre la barre du ruban dans une mémoire tampon.
`CMFCRibbonBar::SaveToXMLFile`	Enregistre la barre du ruban dans un fichier XML.
`CMFCRibbonBar::SetActiveCategory`	Attribue à une catégorie de ruban spécifiée l'état actif.
`CMFCRibbonBar::SetActiveMDIChild`
`CMFCRibbonBar::SetElementKeys`	Définit les touches d'accès spécifiées pour tous les éléments de ruban qui ont l'ID de commande spécifié.
`CMFCRibbonBar::SetApplicationButton`	Affecte un bouton de ruban d'application à la barre du ruban.
`CMFCRibbonBar::SetKeyboardNavigationLevel`
`CMFCRibbonBar::SetMaximizeMode`
`CMFCRibbonBar::SetQuickAccessCommands`	Ajoute un ou plusieurs éléments de ruban à la barre d'outils Accès rapide.
`CMFCRibbonBar::SetQuickAccessDefaultState`	Spécifie l'état par défaut de la barre d'outils Accès rapide.
`CMFCRibbonBar::SetQuickAccessToolbarOnTop`	Positionne la barre d'outils Accès rapide au-dessus ou au-dessous de la barre du ruban.
`CMFCRibbonBar::SetTooltipFixedWidth`
`CMFCRibbonBar::SetWindows7Look`	Active/désactive le style Windows 7 du ruban (bouton d'application petit et rectangulaire).
`CMFCRibbonBar::ShowCategory`	Affiche ou masque la catégorie de ruban spécifiée.
`CMFCRibbonBar::ShowContextCategories`	Affiche ou masque les catégories de contexte qui ont l'ID spécifié.
`CMFCRibbonBar::ShowKeyTips`
`CMFCRibbonBar::ToggleMimimizeState`	Fait basculer la barre du ruban entre les états réduit et agrandi.
`CMFCRibbonBar::TranslateChar`

Notes

Microsoft a inauguré l'Office Fluent Ribbon à l'occasion du lancement simultané de Microsoft Office 2007. Cette barre de ruban n’est pas seulement un nouveau contrôle. Elle représente un nouveau modèle d'interface utilisateur. Le ruban est un volet qui contient un ensemble d'onglets appelés catégories. Chaque catégorie est logiquement divisée en volets de ruban et chaque volet peut contenir plusieurs contrôles et boutons de commande.

Les éléments qui figurent sur la barre du ruban peuvent être développés et réduits pour utiliser au mieux l’espace disponible. Par exemple, si l'espace dont dispose un volet du ruban n'est pas suffisant pour afficher ses éléments, il devient un bouton de menu qui affiche des sous-éléments dans un menu contextuel. La barre du ruban se comporte comme une barre de contrôle (non flottante) statique qui peut être ancrée dans la partie supérieure d'un cadre.

Vous pouvez utiliser la classe CMFCRibbonStatusBar pour implémenter une barre d'état semblable à celle utilisée dans Office 2007. Une catégorie de ruban contient (et affiche) un groupe de panneaux de ruban. Chaque panneau de ruban contient un ou plusieurs éléments du ruban, qui sont dérivés de CMFCRibbonBaseElement.

Pour plus d’informations sur l’ajout d’une barre de ruban à votre application MFC existante, consultez Procédure pas à pas : Mise à jour de l’application scribble MFC.

Hiérarchie d'héritage

Spécifications

En-têteafxribbonbar.h:

`CMFCRibbonBar::ActivateContextCategory`

Active une catégorie de contexte déjà visible.

BOOL ActivateContextCategory(UINT uiContextID);

Paramètres

uiContextID
[in] ID de catégorie de contexte.

Valeur de retour

TRUE si une catégorie de contexte avec est uiContextID trouvée et activée ; sinon FALSE.

`CMFCRibbonBar::AddCategory`

Crée et initialise une nouvelle catégorie de ruban pour la barre de ruban.

CMFCRibbonCategory* AddCategory(
    LPCTSTR lpszName,
    UINT uiSmallImagesResID,
    UINT uiLargeImagesResID,
    CSize sizeSmallImage= CSize(16,
    16),
    CSize sizeLargeImage= CSize(32,
    32),
    int nInsertAt = -1,
    CRuntimeClass* pRTI= NULL);

Paramètres

lpszName
[in] Nom de la catégorie de ruban.

uiSmallImagesResID
[in] ID de ressource de la petite liste d’images pour la catégorie de ruban.

uiLargeImagesResID
[in] ID de ressource de la liste d’images volumineuses pour la catégorie de ruban.

sizeSmallImage
[in] Spécifie la taille des petites images pour la catégorie de ruban.

sizeLargeImage
[in] Spécifie la taille des images volumineuses pour la catégorie de ruban.

nInsertAt
[in] Index de base zéro de l’emplacement de catégorie.

pRTI
[in] Pointeur vers une CMFCRibbonCategory classe d’exécution de classe pour créer dynamiquement une catégorie de ruban au moment de l’exécution.

Valeur de retour

Pointeur vers la nouvelle catégorie de ruban si la méthode a réussi ; sinon, NULL.

Notes

Si le pRTI paramètre n’est pas NULL, la nouvelle catégorie de ruban est créée dynamiquement à l’aide de la classe d’exécution.

Exemple

L’exemple suivant montre comment utiliser la AddCategory méthode dans la CMFCRibbonBar classe.

// Add "Home" category.
// CMFCRibbonBar m_wndRibbonBar
strTemp.LoadString(IDS_RIBBON_HOME);
CMFCRibbonCategory *pCategoryHome = m_wndRibbonBar.AddCategory(strTemp,
                                                               IDB_WRITESMALL, IDB_WRITELARGE);

`CMFCRibbonBar::AddContextCategory`

Crée et initialise une nouvelle catégorie de contexte pour la barre de ruban.

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

Paramètres

lpszName
[in] Nom de la catégorie.

lpszContextName
[in] Nom de la catégorie de contexte légende.

uiContextID
[in] ID de contexte.

clrContext
[in] Couleur de la catégorie de contexte légende.

uiSmallImagesResID
[in] ID de ressource de la petite image d’une catégorie de contexte.

uiLargeImagesResID
[in] ID de ressource de l’image volumineuse d’une catégorie de contexte.

sizeSmallImage
[in] Taille d’une petite image.

sizeLargeImage
[in] Taille d’une grande image.

pRTI
[in] Pointeur vers une classe runtime.

Valeur de retour

Pointeur vers la catégorie nouvellement créée ou NULL si la CreateObject méthode de pRTI ne peut pas créer la catégorie spécifiée.

Notes

Utilisez cette fonction pour ajouter une catégorie de contexte. Les catégories de contexte sont un type spécial de catégorie qui peut être affiché ou masqué lors de l’exécution, en fonction du contexte d’application actuel. Par exemple, lorsque l’utilisateur sélectionne un objet, vous pouvez afficher des onglets spéciaux avec des catégories de contexte, que vous utilisez pour modifier l’objet sélectionné spécifique.

La couleur d’une catégorie de contexte peut être l’une des valeurs suivantes :

AFX_CategoryColor_None
AFX_CategoryColor_Red
AFX_CategoryColor_Orange
AFX_CategoryColor_Yellow
AFX_CategoryColor_Green
AFX_CategoryColor_Blue
AFX_CategoryColor_Indigo
AFX_CategoryColor_Violet

`CMFCRibbonBar::AddMainCategory`

Crée une catégorie de ruban principale pour la barre du ruban.

CMFCRibbonMainPanel* AddMainCategory(
    LPCTSTR lpszName,
    UINT uiSmallImagesResID,
    UINT uiLargeImagesResID,
    CSize sizeSmallImage = CSize(16,
    16),
    CSize sizeLargeImage = CSize(32,
    32));

Paramètres

lpszName
[in] Nom de la catégorie de ruban principale.

uiSmallImagesResID
[in] ID de ressource des petites images.

uiLargeImagesResID
[in] ID de ressource des images volumineuses.

sizeSmallImage
[in] Taille des petites images.

sizeLargeImage
[in] Taille des grandes images.

Valeur de retour

Pointeur vers la nouvelle catégorie de ruban principale si la méthode a réussi ; sinon, NULL.

Notes

Si une catégorie de ruban principale existe déjà, elle est supprimée.

Exemple

L’exemple suivant montre comment utiliser la AddMainCategory méthode dans la CMFCRibbonBar classe.

// m_wndRibbonBar is declared as a protected member variable
// CMFCRibbonBar m_wndRibbonBar.
// strTemp is a CString variable.
strTemp.LoadString(IDS_RIBBON_FILE);
CMFCRibbonMainPanel *pMainPanel = m_wndRibbonBar.AddMainCategory(strTemp,
                                                                 IDB_FILESMALL, IDB_FILELARGE);

`CMFCRibbonBar::AddPrintPreviewCategory`

Crée une catégorie d’aperçu avant impression dans la barre du ruban.

CMFCRibbonCategory* AddPrintPreviewCategory();

Valeur de retour

Pointeur vers la nouvelle catégorie de ruban si la méthode a réussi ; sinon, NULL.

Notes

Cette méthode crée une catégorie de ruban et les contrôles dont elle a besoin pour fournir un aperçu avant impression.

`CMFCRibbonBar::AddQATOnlyCategory`

Crée une catégorie de ruban de barre d’outils d’accès rapide.

CMFCRibbonCategory* AddQATOnlyCategory(
    LPCTSTR lpszName,
    UINT uiSmallImagesResID,
    CSize sizeSmallImage = CSize(16,
    16));

Paramètres

lpszName
[in] Nom de la catégorie.

uiSmallImagesResID
[in] ID de ressource de la liste d’images pour la catégorie.

sizeSmallImage
[in] Taille des images pour les éléments du ruban dans la catégorie.

Valeur de retour

Pointeur vers la nouvelle catégorie si la méthode a réussi ; sinon, NULL.

Notes

La catégorie de ruban de barre d’outils accès rapide est utilisée uniquement dans la boîte de dialogue Personnalisation de la barre d’outils accès rapide.

`CMFCRibbonBar::AddToTabs`

Ajoute l’élément de ruban spécifié à la ligne onglets de la barre de ruban.

void AddToTabs(CMFCRibbonBaseElement* pElement);

Paramètres

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

Notes

L’élément du ruban est positionné avant les boutons système.

`CMFCRibbonBar::CMFCRibbonBar`

Construit et initialise un objet CMFCRibbonBar.

CMFCRibbonBar(BOOL bReplaceFrameCaption = TRUE);

Paramètres

bReplaceFrameCaption
[in] TRUE pour que la barre du ruban remplace la légende de la fenêtre de cadre principale ; FALSE pour localiser la barre du ruban sous la légende de la fenêtre de cadre principal.

Notes

`CMFCRibbonBar::Create`

Crée une fenêtre pour la barre du ruban.

BOOL Create(
    CWnd* pParentWnd,
    DWORD dwStyle = WS_CHILD | WS_VISIBLE | CBRS_TOP,
    UINT nID = AFX_IDW_RIBBON_BAR);

Paramètres

pParentWnd
[in] Pointeur vers la fenêtre parente de la barre du ruban.

dwStyle
[in] Combinaison logique de styles pour la nouvelle fenêtre.

nID
[in] ID de la nouvelle fenêtre.

Valeur de retour

TRUE si la fenêtre a été créée ; sinon FALSE.

Notes

Exemple

L’exemple suivant montre comment utiliser la Create méthode de la CMFCRibbonBar classe.

// CMFCRibbonBar m_wndRibbonBar
m_wndRibbonBar.Create(this, WS_CHILD | CBRS_TOP);

`CMFCRibbonBar::CreateEx`

Crée une fenêtre pour la barre du ruban.

BOOL CreateEx(
    CWnd* pParentWnd,
    DWORD dwCtrlStyle = 0,
    DWORD dwStyle = WS_CHILD | WS_VISIBLE | CBRS_TOP,
    UINT nID = AFX_IDW_RIBBON_BAR);

Paramètres

pParentWnd
[in] Pointeur vers la fenêtre parente de la barre du ruban.

dwCtrlStyle
[in] Ce paramètre n’est pas utilisé.

dwStyle
[in] Combinaison logique de styles pour la nouvelle fenêtre.

nID
[in] ID de la nouvelle fenêtre.

Valeur de retour

TRUE si la fenêtre a été créée ; sinon FALSE.

Notes

`CMFCRibbonBar::DeactivateKeyboardFocus`

Ferme tous les contrôles d’info-clé dans la barre du ruban.

void DeactivateKeyboardFocus(BOOL bSetFocus = TRUE);

Paramètres

bSetFocus
[in] TRUE pour définir le focus sur la fenêtre parente de la barre de ruban.

Notes

`CMFCRibbonBar::DrawMenuImage`

Dessine l’image d’un bouton de menu.

BOOL DrawMenuImage(
    CDC* pDC,
    const CMFCToolBarMenuButton* pMenuItem,
    const CRect& rectImage);

Paramètres

pDC
[in] Pointeur vers un contexte d’appareil pour le bouton de menu.

pMenuItem
[in] Pointeur vers un bouton de menu de barre d’outils.

rectImage
[in] Rectangle d’affichage d’un bouton de menu.

Valeur de retour

TRUE si l’image a été dessinée ; sinon FALSE.

Notes

`CMFCRibbonBar::DWMCompositionChanged`

Ajuste l’affichage de la barre de ruban lorsque la composition du Gestionnaire de fenêtres de bureau (DWM) est activée ou désactivée.

virtual void DWMCompositionChanged();

Notes

`CMFCRibbonBar::EnableKeyTips`

Active ou désactive la fonctionnalité d’info-bulle pour la barre du ruban.

void EnableKeyTips(BOOL bEnable = TRUE);

Paramètres

bEnable
[in] TRUE pour activer la fonctionnalité d’info-bulles ; FALSE pour désactiver la fonctionnalité d’info-bulles.

Notes

Lorsque vous activez cette fonctionnalité, les touches sont affichées lorsque l’utilisateur appuie sur les touches Alt ou F10 . Lorsque l’utilisateur appuie sur alt, les touches touches s’affichent avec un délai de 200 millisecondes. Ce délai permet d’exécuter des raccourcis afin que la touche ALT enfoncée n’interfère pas avec d’autres combinaisons qui incluent la touche ALT.

`CMFCRibbonBar::EnablePrintPreview`

Active ou désactive la fonctionnalité Aperçu avant impression .

void EnablePrintPreview(BOOL bEnable = TRUE);

Paramètres

bEnable
[in] TRUE pour activer la fonctionnalité Aperçu avant impression ; FALSE pour désactiver la fonctionnalité Aperçu avant impression .

Notes

FALSE Si bEnable une catégorie d’aperçu avant impression existe, elle est supprimée.

Par défaut, la fonctionnalité Aperçu avant impression est activée.

`CMFCRibbonBar::EnableToolTips`

Active ou désactive les info-bulles et les descriptions d’info-bulle facultatives dans la barre du ruban.

void EnableToolTips(
    BOOL bEnable = TRUE,
    BOOL bEnableDescr = TRUE);

Paramètres

bEnable
[in] TRUE pour activer les info-bulles dans la barre du ruban ; FALSE pour désactiver les info-bulles dans la barre du ruban.

bEnableDescr
[in] TRUE pour activer les descriptions d’info-bulles sur l’info-bulle ; FALSE pour désactiver les descriptions d’info-bulles sur l’info-bulle.

Notes

Le bEnable paramètre détermine si les info-bulles sont affichées lorsque la souris pointe sur un élément du ruban. Le bEnableDescr paramètre détermine si un texte descriptif supplémentaire s’affiche avec le texte de l’info-bulle.

`CMFCRibbonBar::FindByData`

Récupère un pointeur vers un élément de ruban s’il a les données et la visibilité spécifiées.

CMFCRibbonBaseElement* FindByData(
    DWORD_PTR dwData,
    BOOL bVisibleOnly = TRUE) const;

Paramètres

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

bVisibleOnly
[in] TRUE pour rechercher des éléments du ruban visibles uniquement ; FALSE pour rechercher tous les éléments du ruban.

Valeur de retour

Pointeur vers un élément de ruban s’il a les données et la visibilité spécifiées ; sinon NULL.

Notes

Un élément de ruban est n’importe quel contrôle que vous pouvez ajouter au ruban, tel qu’un bouton du ruban ou une catégorie de ruban, ou un curseur de ruban.

`CMFCRibbonBar::FindByID`

Récupère un pointeur vers l’élément du ruban qui a l’ID de commande et les valeurs de recherche spécifiés.

CMFCRibbonBaseElement* FindByID(
    UINT uiCmdID,
    BOOL bVisibleOnly = TRUE,
    BOOL bExcludeQAT = FALSE) const;

Paramètres

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

bVisibleOnly
[in] TRUE pour rechercher des éléments du ruban visibles uniquement ; FALSE pour rechercher tous les éléments du ruban.

bExcludeQAT
[in] TRUE pour exclure les éléments de barre d’outils d’accès rapide de la recherche ; sinon, FALSE.

Valeur de retour

Pointeur vers un élément du ruban s’il a l’ID de commande et les valeurs de recherche spécifiés ; sinon, NULL.

Notes

Un élément de ruban est n’importe quel contrôle de ruban qui peut être ajouté au ruban, tel qu’un bouton du ruban ou une catégorie de ruban, ou un curseur de ruban.

En général, plusieurs éléments de ruban peuvent avoir le même ID de commande. Si vous souhaitez obtenir des pointeurs vers tous les éléments du ruban qui utilisent un ID de commande spécifié, utilisez la CMFCRibbonBar::GetElementsByID méthode.

`CMFCRibbonBar::FindCategoryIndexByData`

Récupère l’index de la catégorie de ruban qui contient les données spécifiées.

int FindCategoryIndexByData(DWORD dwData) const;

Paramètres

dwData
[in] Données associées à une catégorie de ruban.

Valeur de retour

Index de base zéro d’une catégorie de ruban si la méthode a réussi ; sinon -1.

`CMFCRibbonBar::ForceRecalcLayout`

Ajuste la disposition de tous les éléments de la barre du ruban et de la fenêtre parente et redessine toute la fenêtre.

void ForceRecalcLayout();

Notes

`CMFCRibbonBar::GetActiveCategory`

Récupère un pointeur vers la catégorie de ruban active.

CMFCRibbonCategory* GetActiveCategory() const;

Valeur de retour

Pointeur vers la catégorie de ruban active ; ou NULL si aucune catégorie n’est active.

Notes

Une catégorie est active si elle a le focus. Par défaut, la catégorie active est la première catégorie située à gauche de la barre du ruban.

La catégorie principale s’affiche lorsque l’utilisateur appuie sur le bouton de l’application et qu’il ne peut pas s’agir de la catégorie active.

`CMFCRibbonBar::GetApplicationButton`

Récupère un pointeur vers le bouton d’application.

CMFCRibbonApplicationButton* GetApplicationButton() const;

Valeur de retour

Pointeur vers le bouton d’application ; ou NULL si le bouton n’a pas été défini.

`CMFCRibbonBar::GetCaptionHeight`

Récupère la hauteur de la zone de légende pour la barre du ruban.

int GetCaptionHeight() const;

Valeur de retour

Hauteur, en pixels, de la zone de légende pour la barre du ruban.

Notes

`CMFCRibbonBar::GetCategory`

Récupère un pointeur vers la catégorie de ruban à l’index spécifié.

CMFCRibbonCategory* GetCategory(int nIndex) const;

Paramètres

nIndex
[in] Index de base zéro d’une catégorie de ruban dans la liste des catégories de ruban contenues dans la barre du ruban.

Valeur de retour

Pointeur vers la catégorie de ruban à l’index spécifié ; sinon, NULL si nIndex elle était hors limites.

`CMFCRibbonBar::GetCategoryCount`

Récupère le nombre de catégories de ruban dans la barre de ruban.

int GetCategoryCount() const;

Valeur de retour

Nombre de catégories de ruban dans la barre du ruban.

`CMFCRibbonBar::GetCategoryHeight`

Récupère la hauteur de la catégorie.

int GetCategoryHeight() const;

Valeur de retour

Hauteur de la catégorie.

Notes

La hauteur de catégorie inclut la hauteur de l’onglet Catégorie.

`CMFCRibbonBar::GetCategoryIndex`

Récupère l’index de la catégorie de ruban spécifiée.

int GetCategoryIndex(CMFCRibbonCategory* pCategory) const;

Paramètres

pCategory
[in] Pointeur vers une catégorie de ruban.

Valeur de retour

Index de base zéro d’une catégorie de ruban spécifiée par pCategory; ou -1 si la catégorie de ruban n’est pas trouvée.

`CMFCRibbonBar::GetContextName`

Récupère le nom de la catégorie de contexte légende spécifiée par un ID de contexte.

BOOL GetContextName(
    UINT uiContextID,
    CString& strName) const;

Paramètres

uiContextID
[in] ID de contexte de catégorie de ruban.

strName
[out] Nom d’une catégorie de contexte légende.

Valeur de retour

TRUEsi la méthode a réussi ; sinon, FALSE si uiContextID elle était égale à zéro ou si la catégorie de contexte légende n’a pas été trouvée.

`CMFCRibbonBar::GetDroppedDown`

Récupère l’élément du ruban actuellement supprimé.

virtual CMFCRibbonBaseElement* GetDroppedDown();

Valeur de retour

Élément du ruban actuellement supprimé ; ou NULL si aucun élément du ruban n’est actuellement supprimé.

Notes

`CMFCRibbonBar::GetElementsByID`

Récupère un tableau de pointeurs vers tous les éléments du ruban qui ont un ID de commande spécifique.

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

Paramètres

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

arButtons
[out] Tableau de pointeurs vers les éléments du ruban.

Notes

Plusieurs éléments du ruban peuvent avoir le même ID de commande, car certains éléments du ruban peuvent être copiés dans la barre d’outils Accès rapide.

`CMFCRibbonBar::GetHideFlags`

Récupère les indicateurs qui indiquent la quantité de la barre de ruban visible.

DWORD GetHideFlags() const;

Valeur de retour

Indicateurs qui indiquent la quantité de la barre du ruban visible.

Notes

Le tableau suivant répertorie la combinaison possible d’indicateurs pour la valeur de retour :

Indicateur	Description
`AFX_RIBBONBAR_HIDE_ELEMENTS`	La barre du ruban est réduite verticalement et seuls les onglets de catégorie, le bouton principal et la barre d’outils d’accès rapide sont visibles.
`AFX_RIBBONBAR_HIDE_ALL`	La largeur de la barre de ruban est inférieure à la largeur minimale et est complètement masquée.

`CMFCRibbonBar::GetItemIDsList`

Récupère les ID de commande pour la collection spécifiée d’éléments de ruban dans la barre de ruban.

void GetItemIDsList(CList<UINT, UINT>& lstItems,
    BOOL bHiddenOnly = FALSE) const;

Paramètres

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

bHiddenOnly
[in] TRUE pour exclure les éléments du ruban affichés ; FALSE pour inclure tous les éléments du ruban dans la barre du ruban.

Notes

`CMFCRibbonBar::GetKeyboardNavigationLevel`

Récupère le niveau de navigation actuel lorsque l’utilisateur appuie sur les touches contenues dans la barre du ruban.

int GetKeyboardNavigationLevel() const;

Valeur de retour

Niveau de navigation actuel lorsque l’utilisateur appuie sur les touches contenues dans la barre du ruban. Le tableau suivant répertorie les valeurs de retour possibles :

Value	Description
-1	Les touches d’accès ne sont pas affichées.
0	Les touches d’accès sont affichées.
1	L’utilisateur a appuyé sur une info-bulle affichée.

Notes

`CMFCRibbonBar::GetKeyboardNavLevelCurrent`

Récupère l’objet de navigation clavier actuel dans la barre du ruban.

CObject* GetKeyboardNavLevelCurrent() const;

Valeur de retour

Objet de navigation clavier actuel dans la barre du ruban ; sinon NULL , si aucun objet n’affiche actuellement des info-clés.

Notes

L’objet qui affiche actuellement des touches est l’objet de navigation clavier actuel.

`CMFCRibbonBar::GetKeyboardNavLevelParent`

Récupère l’objet de navigation du clavier parent dans la barre du ruban.

CObject* GetKeyboardNavLevelParent() const;

Valeur de retour

Objet de navigation du clavier parent dans la barre du ruban ; sinon NULL.

Notes

Lorsque l’utilisateur appuie sur une touche d’info-bulle sur la barre du ruban, l’objet de navigation clavier actuel devient l’objet de navigation du clavier parent.

`CMFCRibbonBar::GetMainCategory`

Récupère un pointeur vers la catégorie de ruban principale.

CMFCRibbonCategory* GetMainCategory() const;

Valeur de retour

Pointeur vers la catégorie de ruban principale.

Notes

La catégorie de ruban principale contient le panneau principal du ruban.

`CMFCRibbonBar::GetQATCommandsLocation`

Récupère le rectangle d’affichage de la section commandes de la barre d’outils Accès rapide.

CRect GetQATCommandsLocation() const;

Valeur de retour

Rectangle d’affichage de la section commandes de la barre d’outils Accès rapide.

Notes

La section commandes du rectangle d’affichage n’inclut pas le bouton de personnalisation.

`CMFCRibbonBar::GetQATDroppedDown`

Récupère un pointeur vers l’élément du ruban dans la barre d’outils d’accès rapide dont le menu contextuel est déroulant.

CMFCRibbonBaseElement* GetQATDroppedDown();

Valeur de retour

Pointeur vers l’élément du ruban dans la barre d’outils d’accès rapide dont le menu contextuel est déroulant.

Notes

`CMFCRibbonBar::GetQuickAccessCommands`

Récupère une liste d’ID de commande pour les éléments du ruban dans la barre d’outils accès rapide.

void GetQuickAccessCommands(CList<UINT,UINT>& lstCommands);

Paramètres

lstCommands
[out] Liste des ID de commande pour les éléments du ruban dans la barre d’outils accès rapide.

Notes

La liste ne contient pas d’éléments de ruban qui sont des séparateurs de contrôle.

`CMFCRibbonBar::GetQuickAccessToolbarLocation`

Récupère le rectangle d’affichage de la barre d’outils accès rapide.

CRect GetQuickAccessToolbarLocation() const;

Valeur de retour

Rectangle d’affichage de la barre d’outils Accès rapide.

Notes

`CMFCRibbonBar::GetTabTrancateRatio`

Récupère la réduction de la taille du pourcentage dans la largeur d’affichage des onglets de catégorie.

int GetTabTrancateRatio() const;

Valeur de retour

Réduction de la taille du pourcentage dans la largeur d’affichage des onglets de catégorie.

Notes

Les onglets de catégorie sont réduits en largeur lorsqu’il n’y a pas suffisamment de largeur sur la barre du ruban.

`CMFCRibbonBar::GetTooltipFixedWidthLargeImage`

Récupère la grande taille de largeur de l’info-bulle pour la barre du ruban.

int GetTooltipFixedWidthLargeImage() const;

Valeur de retour

Grande taille de largeur d’info-bulle en pixels.

Notes

Si la grande taille de la largeur de l’info-bulle est 0, la largeur varie.

`CMFCRibbonBar::GetTooltipFixedWidthRegular`

Récupère la taille normale de la largeur de l’info-bulle pour la barre du ruban.

int GetTooltipFixedWidthRegular() const;

Valeur de retour

Taille normale de la largeur de l’info-bulle en pixels.

Notes

Si la taille normale de la largeur de l’info-bulle est 0, la largeur varie.

`CMFCRibbonBar::GetVisibleCategoryCount`

Récupère le nombre de catégories visibles dans la barre du ruban.

int GetVisibleCategoryCount() const;

Valeur de retour

Nombre de catégories visibles dans la barre du ruban.

Notes

`CMFCRibbonBar::HideAllContextCategories`

Masque toutes les catégories de contexte dans la barre du ruban.

BOOL HideAllContextCategories();

Valeur de retour

TRUE si au moins une catégorie de contexte a été masquée ; sinon, FALSE.

Notes

Si une catégorie de contexte est active, la catégorie active est réinitialisée à la première catégorie visible dans la liste des catégories.

`CMFCRibbonBar::HideKeyTips`

Masque toutes les info-bulles dans la barre du ruban.

void HideKeyTips();

Notes

`CMFCRibbonBar::HitTest`

Récupère un pointeur vers l’élément du ruban spécifié par l’emplacement du point.

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

Paramètres

point
[in] Emplacement du point dans les coordonnées de la barre du ruban.

bCheckActiveCategory
[in] TRUE pour rechercher la catégorie active ; FALSE pour ne pas rechercher la catégorie active.

bCheckPanelCaption
[in] TRUE pour tester la légende du panneau du ruban avec le point situé dans celui-ci ; FALSE ne pas tester le légende du panneau du ruban avec le point situé dans celui-ci. Pour plus d’informations, consultez la section Remarques.

Valeur de retour

Pointeur vers l’élément du ruban situé au point spécifié ; sinon NULL , si le point n’est pas situé dans un élément du ruban.

Notes

L’légende du panneau du ruban avec le point situé dans celui-ci n’est pas testé, sauf si le bCheckActiveCategory paramètre est TRUE.

`CMFCRibbonBar::IsKeyTipEnabled`

Indique si la fonctionnalité d’info-clés est activée.

BOOL IsKeyTipEnabled() const;

Valeur de retour

TRUE si la fonctionnalité d’info-clés est activée ; sinon FALSE.

`CMFCRibbonBar::IsMainRibbonBar`

Indique si la barre du ruban est la barre de ruban principale.

virtual BOOL IsMainRibbonBar() const;

Valeur de retour

Retourne toujours TRUE.

Notes

Par défaut, cette méthode retourne TRUEtoujours . Remplacez cette méthode pour indiquer si la barre du ruban est la barre de ruban principale.

`CMFCRibbonBar::IsPrintPreviewEnabled`

Indique si la fonctionnalité Aperçu avant impression est activée.

BOOL IsPrintPreviewEnabled() const;

Valeur de retour

TRUE si la fonctionnalité Aperçu avant impression est activée ; sinon FALSE.

`CMFCRibbonBar::IsQATEmpty`

Indique si la barre d’outils accès rapide contient des boutons de commande.

BOOL IsQATEmpty() const;

Valeur de retour

TRUE si la barre d’outils Accès rapide contient des boutons de commande ; sinon FALSE.

Notes

`CMFCRibbonBar::IsQuickAccessToolbarOnTop`

Indique si la barre d’outils accès rapide se trouve sur ou sous la barre du ruban.

BOOL IsQuickAccessToolbarOnTop() const;

Valeur de retour

TRUE si la barre d’outils accès rapide se trouve sur la barre du ruban ; FALSE si la barre d’outils accès rapide se trouve sous la barre du ruban.

`CMFCRibbonBar::IsReplaceFrameCaption`

Indique si la barre du ruban remplace ou se trouve sous la légende de la fenêtre de cadre principale.

BOOL IsReplaceFrameCaption() const;

Valeur de retour

TRUEsi la barre du ruban remplace la légende de la fenêtre de cadre principale ; FALSE si la barre du ruban se trouve sous la légende de la fenêtre de cadre principal.

`CMFCRibbonBar::IsShowGroupBorder`

Indique si les groupes de boutons situés dans la barre du ruban affichent une bordure de groupe.

virtual BOOL IsShowGroupBorder(CMFCRibbonButtonsGroup* pGroup) const;

Paramètres

pGroup
[in] Ce paramètre n’est pas utilisé.

Valeur de retour

Retourne toujours FALSE.

Notes

Par défaut, cette méthode retourne FALSEtoujours . Remplacez cette méthode pour indiquer si les groupes de boutons situés dans la barre du ruban affichent une bordure de groupe.

`CMFCRibbonBar::IsToolTipDescrEnabled`

Indique si les descriptions d’info-bulles sont activées.

BOOL IsToolTipDescrEnabled() const;

Valeur de retour

TRUE si les descriptions d’info-bulles sont activées ; FALSE si les descriptions d’info-bulles sont désactivées.

Notes

Les descriptions d’info-bulles sont un texte descriptif supplémentaire affiché avec le texte de l’info-bulle.

`CMFCRibbonBar::IsToolTipEnabled`

Indique si les info-bulles sont activées ou désactivées pour la barre du ruban.

BOOL IsToolTipEnabled() const;

Valeur de retour

TRUE si les info-bulles sont activées ; FALSE si les info-bulles sont désactivées.

`CMFCRibbonBar::IsTransparentCaption`

Indique si l’affichage est défini pour le jeu de couleurs Windows Aero.

BOOL IsTransparentCaption() const;

Valeur de retour

TRUE si le jeu de couleurs est Windows Aero ; sinon FALSE.

Notes

`CMFCRibbonBar::OnClickButton`

Cette méthode est conservée pour la compatibilité descendante avec les applications existantes et ne doit pas être utilisée pour le nouveau développement.

virtual void OnClickButton(
    CMFCRibbonButton* pButton,
    CPoint point);

Paramètres

pButton
[in] Pointeur vers le bouton sur lequel vous avez cliqué.

point
[in] Ce paramètre n’est pas utilisé.

Notes

`CMFCRibbonBar::OnEditContextMenu`

virtual void OnEditContextMenu(
    CMFCRibbonRichEditCtrl* pEdit,
    CPoint point);

Paramètres

[in] pEdit
[in] point\

Notes

`CMFCRibbonBar::OnRTLChanged`

Appelé par l’infrastructure lorsque la disposition change de direction.

virtual void OnRTLChanged(BOOL bIsRTL);

Paramètres

bIsRTL
[in] TRUE si la disposition est de droite à gauche ; FALSE si la disposition est de gauche à droite.

Notes

Cette méthode ajuste la disposition de tous les contrôles de la barre de ruban pour la nouvelle direction de disposition.

`CMFCRibbonBar::OnSetAccData`

Cette méthode est interne à l’infrastructure et n’est pas destinée à être appelée à partir du code utilisateur.

BOOL OnSetAccData(long lVal);

Paramètres

long lVal Index de l’objet accessible.

Valeur de retour

S_OK si elle réussit ; sinon FALSE ou S_FALSE.

Notes

`CMFCRibbonBar::OnShowRibbonContextMenu`

virtual BOOL OnShowRibbonContextMenu(
    CWnd* pWnd,
    int x,
    int y,
    CMFCRibbonBaseElement* pHit);

Paramètres

[in] pWnd
[in] x
[in] y
[in] pHit\

Valeur de retour

Notes

`CMFCRibbonBar::OnShowRibbonQATMenu`

virtual BOOL OnShowRibbonQATMenu(
    CWnd* pWnd,
    int x,
    int y,
    CMFCRibbonBaseElement* pHit);

Paramètres

[in] pWnd
[in] x
[in] y
[in] pHit\

Valeur de retour

Notes

`CMFCRibbonBar::OnSysKeyDown`

Appelé par l’infrastructure lorsque l’utilisateur appuie sur la touche F10 ou maintient la touche Alt enfoncée, puis appuie sur une autre touche.

BOOL OnSysKeyDown(
    CFrameWnd* pFrameWnd,
    WPARAM wParam,
    LPARAM lParam);

Paramètres

pFrameWnd
[in] Pointeur vers la fenêtre du cadre principal parent de la barre du ruban.

wParam
[in] Code de clé virtuelle de la touche enfoncée.

lParam
[in] Indicateurs d’état du clavier lorsque la touche a été enfoncée.

Valeur de retour

TRUE si l’événement de frappe a été traité ; sinon FALSE.

Notes

`CMFCRibbonBar::OnSysKeyUp`

Appelé par l’infrastructure lorsque l’utilisateur libère la touche F10 , la touche ALT ou une touche qui a été enfoncée lorsque la touche ALT a été enfoncée.

BOOL OnSysKeyUp(
    CFrameWnd* pFrameWnd,
    WPARAM wParam,
    LPARAM lParam);

Paramètres

pFrameWnd
[in] Pointeur vers la fenêtre du cadre principal parent de la barre du ruban.

wParam
[in] Code de clé virtuelle de la clé en cours de publication.

lParam
[in] Ce paramètre n’est pas utilisé.

Valeur de retour

TRUE si l’événement de frappe a été traité ; sinon FALSE.

Notes

`CMFCRibbonBar::PopTooltip`

Supprime une info-bulle de l’affichage.

void PopTooltip();

Notes

`CMFCRibbonBar::PreTranslateMessage`

Détermine si le message spécifié est traité par la barre du ruban.

virtual BOOL PreTranslateMessage(MSG* pMsg);

Paramètres

pMsg
[in] Pointeur vers un message.

Valeur de retour

TRUE si le message a été traité par la barre du ruban ; sinon FALSE.

Notes

`CMFCRibbonBar::RecalcLayout`

Ajuste la disposition de tous les contrôles de la barre du ruban.

virtual void RecalcLayout();

Notes

Après l’ajustement de la disposition, l’affichage de la barre de ruban est mis à jour.

`CMFCRibbonBar::RemoveAllCategories`

Supprime toutes les catégories de ruban de la barre de ruban.

void RemoveAllCategories();

Notes

Cette méthode supprime toutes les catégories de ruban de la mémoire et de la liste des catégories.

`CMFCRibbonBar::RemoveAllFromTabs`

Supprime tous les éléments de ruban de la zone d'onglet.

void RemoveAllFromTabs();

Notes

Utilisez cette fonction si vous souhaitez supprimer tous les éléments que vous avez ajoutés à la zone d’onglet à l’aide CMFCRibbonBar::AddToTabs de la méthode.

`CMFCRibbonBar::RemoveCategory`

Supprime la catégorie de ruban spécifiée de la barre de ruban.

BOOL RemoveCategory(int nIndex);

Paramètres

nIndex
[in] Index de base zéro d’une catégorie dans la liste des catégories de ruban contenues dans la barre du ruban.

Valeur de retour

TRUE si la catégorie de ruban spécifiée a été supprimée ; sinon FALSE.

Notes

La catégorie de ruban spécifiée est supprimée de la mémoire et de la liste des catégories.

`CMFCRibbonBar::SetActiveCategory`

Définit la catégorie de ruban spécifiée comme catégorie active.

BOOL SetActiveCategory(
    CMFCRibbonCategory* pCategory,
    BOOL bForceRestore= FALSE);

Paramètres

pCategory
[in] Catégorie de ruban contenue dans la barre du ruban.

bForceRestore
[in] TRUE pour optimiser la barre du ruban si elle est réduite ; FALSE pour afficher la catégorie active dans une fenêtre contextuelle si la barre du ruban est réduite.

Valeur de retour

TRUE si la catégorie spécifiée a été définie comme catégorie active ; sinon FALSE.

Notes

La catégorie de ruban principale ne peut pas être la catégorie active.

Si la catégorie spécifiée par pCategory n’est pas affichée, elle ne peut pas être définie comme catégorie active.

`CMFCRibbonBar::SetActiveMDIChild`

Associe les boutons système de la barre de ruban qui appartiennent à une fenêtre enfant multi-document (MDI) à la fenêtre enfant MDI spécifiée.

void SetActiveMDIChild(CWnd* pWnd);

Paramètres

pWnd
[in] Pointeur vers une fenêtre enfant MDI.

Notes

`CMFCRibbonBar::SetApplicationButton`

Affecte un bouton de ruban d'application à la barre du ruban.

void SetApplicationButton(
    CMFCRibbonApplicationButton* pButton,
    CSize sizeButton);

Paramètres

pButton
[in] Pointeur vers le bouton du ruban de l’application.

sizeButton
[in] Taille du bouton du ruban de l’application.

Notes

Le bouton du ruban de l’application est un grand bouton arrondi situé dans le coin supérieur gauche du contrôle Ruban.

Exemple

L’exemple suivant montre comment utiliser la SetApplicationButton méthode dans la CMFCRibbonBar classe.

// Init main button:
// CMFCRibbonApplicationButton m_MainButton
m_MainButton.SetImage(IDB_MAIN);
m_MainButton.SetText(_T("\nf"));
m_MainButton.SetToolTipText(strTemp);

// CMFCRibbonBar m_wndRibbonBar
m_wndRibbonBar.SetApplicationButton(&m_MainButton, CSize(45, 45));

`CMFCRibbonBar::SetElementKeys`

Définit les touches pour tous les éléments du ruban qui ont l’ID de commande spécifié.

BOOL SetElementKeys(
    UINT uiCmdID,
    LPCTSTR lpszKeys,
    LPCTSTR lpszMenuKeys= NULL);

Paramètres

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

lpszKeys
[in] Info-bulle.

lpszMenuKeys
[in] Info-bulle du menu.

Valeur de retour

TRUE si les touches d’au moins un élément du ruban sont définies ; sinon FALSE.

Notes

L’info-bulle de menu facultative concerne les éléments du ruban avec un bouton fractionné qui ouvre un menu contextuel.

`CMFCRibbonBar::SetKeyboardNavigationLevel`

Définit le niveau de navigation clavier lorsque l’utilisateur appuie sur les touches contenues dans la barre du ruban.

void SetKeyboardNavigationLevel(
    CObject* pLevel,
    BOOL bSetFocus = TRUE);

Paramètres

pLevel
[in] Pointeur vers l’objet de navigation clavier actuel.

bSetFocus
[in] TRUE pour définir le focus clavier sur la barre du ruban.

Notes

La navigation au clavier de la barre du ruban démarre lorsque l’utilisateur appuie sur la touche Alt ou F10 . L’utilisateur sélectionne le niveau de navigation suivant en appuyant sur une info-bulle sur la barre du ruban. L’utilisateur peut revenir au niveau de navigation précédent en appuyant sur la touche d’échappement.

`CMFCRibbonBar::SetMaximizeMode`

Ajuste la barre du ruban lorsque la taille de la fenêtre d’une fenêtre enfant multidocument (MDI) entre ou quitte l’état agrandi.

void SetMaximizeMode(
    BOOL bMax,
    CWnd* pWnd = NULL);

Paramètres

bMax
[in] TRUE pour afficher les boutons système d’une fenêtre enfant MDI dans la barre du ruban ; FALSE pour supprimer les boutons système d’une fenêtre enfant MDI de la barre du ruban.

pWnd
[in] Pointeur vers la fenêtre de cadre principale de la barre du ruban.

Notes

La barre du ruban affiche les boutons système d’une fenêtre enfant MDI dans la ligne d’onglet lorsqu’une fenêtre enfant MDI est agrandie.

`CMFCRibbonBar::SetQuickAccessCommands`

Ajoute un ou plusieurs éléments de ruban à la barre d'outils Accès rapide.

void SetQuickAccessCommands(
    const CList<UINT,UINT>& lstCommands,
    BOOL bRecalcLayout=TRUE);

Paramètres

lstCommands
[in] Liste des commandes à placer dans la barre d’outils Accès rapide.

bRecalcLayout
[in] TRUE si vous souhaitez redessiner le ruban après avoir ajouté les éléments du ruban ; FALSE Sinon.

Exemple

L’exemple suivant montre comment utiliser la SetQuickAccessCommands méthode dans la CMFCRibbonBar classe.

// Add quick access commands to the toolbar
CList<UINT, UINT> lstQATCmds;

lstQATCmds.AddTail(ID_FILE_NEW);
lstQATCmds.AddTail(ID_FILE_OPEN);
lstQATCmds.AddTail(ID_FILE_SAVE);
lstQATCmds.AddTail(ID_FILE_PRINT_DIRECT);

// CMFCRibbonBar m_wndRibbonBar
m_wndRibbonBar.SetQuickAccessCommands(lstQATCmds);

`CMFCRibbonBar::SetQuickAccessDefaultState`

Définit la barre d’outils accès rapide à l’état par défaut.

void SetQuickAccessDefaultState(const CMFCRibbonQuickAccessToolBarDefaultState& state);

Paramètres

state
[in] État par défaut de la barre d’outils accès rapide.

Notes

L’état de la barre d’outils accès rapide inclut une liste de commandes et leur visibilité.

Exemple

L’exemple suivant montre comment utiliser la SetQuickAccessDefaultState méthode dans la CMFCRibbonBar classe.

CMFCRibbonQuickAccessToolBarDefaultState *qaToolBarState =
    new CMFCRibbonQuickAccessToolBarDefaultState();
qaToolBarState->AddCommand(ID_FILE_NEW, true);
qaToolBarState->AddCommand(ID_FILE_OPEN, true);
// CMFCRibbonBar m_wndRibbonBar
m_wndRibbonBar.SetQuickAccessDefaultState(*qaToolBarState);

`CMFCRibbonBar::SetQuickAccessToolbarOnTop`

Positionne la barre d’outils accès rapide au-dessus ou au-dessous de la barre du ruban.

void SetQuickAccessToolbarOnTop(BOOL bOnTop);

Paramètres

bOnTop
[in] TRUE pour positionner la barre d’outils accès rapide au-dessus de la barre du ruban ; FALSE pour positionner la barre d’outils accès rapide sous la barre du ruban.

`CMFCRibbonBar::SetTooltipFixedWidth`

Définit les tailles régulières et volumineuses des largeurs fixes d’info-bulle pour la barre du ruban.

void SetTooltipFixedWidth(
    int nWidthRegular,
    int nWidthLargeImage);

Paramètres

nWidthRegular
[in] Largeur, en pixels, d’une info-bulle de taille fixe régulière.

nWidthLargeImage
[in] Largeur, en pixels, d’une info-bulle de grande taille fixe.

Notes

La définition d’un paramètre sur 0 entraîne la variation de la largeur correspondante.

`CMFCRibbonBar::ShowCategory`

Affiche ou masque la catégorie de ruban spécifiée.

void ShowCategory(
    int nIndex,
    BOOL bShow=TRUE);

Paramètres

nIndex
[in] Index de la catégorie de ruban.

bShow
[in] Si TRUE, affichez la catégorie du ruban ; sinon, masquez la catégorie du ruban.

`CMFCRibbonBar::ShowContextCategories`

Affiche ou masque les catégories de contexte qui ont l'ID spécifié.

void ShowContextCategories(
    UINT uiContextID,
    BOOL bShow=TRUE);

Paramètres

uiContextID
[in] ID de catégorie de contexte.

bShow
[in] Si TRUE, affichez les catégories qui ont l’ID spécifié ; sinon, masquez les catégories qui ont l’ID spécifié.

`CMFCRibbonBar::ShowKeyTips`

Affiche les touches pour chaque élément du ruban dans la barre du ruban.

void ShowKeyTips();

Notes

`CMFCRibbonBar::ToggleMimimizeState`

Bascule la barre du ruban entre les états réduits et agrandis.

void ToggleMimimizeState();

Notes

L’orthographe incorrecte dans le nom de la méthode est un problème connu.

Dans l’état réduit, le contrôle du ruban est masqué et seuls les onglets sont affichés. Lorsque l’utilisateur clique sur un onglet, le contrôle du ruban s’affiche sous la forme d’une fenêtre contextuelle. La fenêtre se ferme lorsque l’utilisateur clique ou exécute une commande.

`CMFCRibbonBar::TranslateChar`

Détermine si le code de caractère de frappe spécifié est traité par la barre du ruban.

virtual BOOL TranslateChar(UINT nChar);

Paramètres

nChar
[in] Code de caractère de frappe utilisateur.

Valeur de retour

TRUE si le code de caractère a été traité par la barre du ruban ; sinon FALSE.

Notes

La fonctionnalité d’info-touches permet aux utilisateurs de naviguer dans la barre du ruban à l’aide du clavier.

`CMFCRibbonBar::GetFocused`

Retourne un élément qui a le focus.

virtual CMFCRibbonBaseElement* GetFocused();

Valeur de retour

Pointeur vers un élément ciblé ou NULL.

Notes

`CMFCRibbonBar::IsWindows7Look`

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

BOOL IsWindows7Look() const;

Valeur de retour

TRUE si le ruban a une apparence Windows 7 ; sinon FALSE.

Notes

`CMFCRibbonBar::LoadFromResource`

Surcharge. Charge une barre de ruban à partir des ressources d'application.

virtual BOOL LoadFromResource(
    UINT uiXMLResID,
    LPCTSTR lpszResType = RT_RIBBON,
    HINSTANCE hInstance = NULL);

virtual BOOL LoadFromResource(
    LPCTSTR lpszXMLResID,
    LPCTSTR lpszResType = RT_RIBBON,
    HINSTANCE hInstance = NULL);

Paramètres

uiXMLResID
Spécifie l’ID de ressource de la chaîne XML avec les informations de barre de ruban.

lpszResType
Spécifie le type de la ressource située à l’emplacement uiXMLResID.

hInstance
Gérez le module dont le fichier exécutable contient la ressource. Si hInstance c’est NULLle cas, le système charge la ressource à partir du module utilisé pour créer le processus actuel.

lpszXMLResID
Spécifie l’ID de ressource (sous forme de chaîne) avec les informations de barre de ruban.

Valeur de retour

TRUE si la charge réussit ; sinon FALSE.

Notes

`CMFCRibbonBar::SaveToXMLBuffer`

Enregistre la barre du ruban dans une mémoire tampon.

UINT SaveToXMLBuffer(LPBYTE* ppBuffer) const;

Paramètres

ppBuffer
Lorsque cette fonction est retournée, ppBuffer pointe vers une mémoire tampon allouée par cette méthode et contient des informations de barre de ruban au format XML.

Valeur de retour

TRUE en cas de réussite ; sinon, FALSE.

Notes

`CMFCRibbonBar::SaveToXMLFile`

Enregistre la barre du ruban dans un fichier XML.

BOOL SaveToXMLFile(LPCTSTR lpszFilePath) const;

Paramètres

lpszFilePath
Spécifie le fichier de sortie.

Valeur de retour

TRUE en cas de réussite ; sinon, FALSE.

Notes

`CMFCRibbonBar::SetWindows7Look`

Active ou désactive une apparence Windows 7 (petit bouton d’application rectangulaire) pour le ruban.

void SetWindows7Look(
    BOOL bWindows7Look,
    BOOL bRecalc = TRUE);

Paramètres

bWindows7Look
TRUE définit une apparence Windows 7 ; FALSE Sinon.

bRecalc
TRUE recalcule la disposition du ruban ; FALSE Sinon.

Notes

Voir aussi

Graphique hiérarchique
Classes
CPane Classe
CMFCRibbonCategory Classe
CMFCRibbonPanel Classe
CMFCRibbonBaseElement Classe
Procédure pas à pas : mise à jour de l’application scribble MFC

Share via

La classe CMFCRibbonBar

Syntaxe

Membres

Constructeurs publics

Méthodes publiques

Notes

Hiérarchie d'héritage

Spécifications

CMFCRibbonBar::ActivateContextCategory

Paramètres

Valeur de retour

CMFCRibbonBar::AddCategory

Paramètres

Valeur de retour

Notes

Exemple

CMFCRibbonBar::AddContextCategory

Paramètres

Valeur de retour

Notes

CMFCRibbonBar::AddMainCategory

Paramètres

Valeur de retour

Notes

Exemple

CMFCRibbonBar::AddPrintPreviewCategory

Valeur de retour

Notes

CMFCRibbonBar::AddQATOnlyCategory

Paramètres

Valeur de retour

Notes

CMFCRibbonBar::AddToTabs

Paramètres

Notes

CMFCRibbonBar::CMFCRibbonBar

Paramètres

Notes

CMFCRibbonBar::Create

Paramètres

Valeur de retour

Notes

Exemple

CMFCRibbonBar::CreateEx

Paramètres

Valeur de retour

Notes

CMFCRibbonBar::DeactivateKeyboardFocus

Paramètres

Notes

CMFCRibbonBar::DrawMenuImage

Paramètres

Valeur de retour

Notes

CMFCRibbonBar::DWMCompositionChanged

Notes

CMFCRibbonBar::EnableKeyTips

Paramètres

Notes

CMFCRibbonBar::EnablePrintPreview

Paramètres

Notes

CMFCRibbonBar::EnableToolTips

Paramètres

Notes

CMFCRibbonBar::FindByData

Paramètres

Valeur de retour

Notes

CMFCRibbonBar::FindByID

Paramètres

Valeur de retour

Notes

CMFCRibbonBar::FindCategoryIndexByData

Paramètres

Valeur de retour

CMFCRibbonBar::ForceRecalcLayout

Notes

CMFCRibbonBar::GetActiveCategory

La classe `CMFCRibbonBar`

`CMFCRibbonBar::ActivateContextCategory`

`CMFCRibbonBar::AddCategory`

`CMFCRibbonBar::AddContextCategory`

`CMFCRibbonBar::AddMainCategory`

`CMFCRibbonBar::AddPrintPreviewCategory`

`CMFCRibbonBar::AddQATOnlyCategory`

`CMFCRibbonBar::AddToTabs`

`CMFCRibbonBar::CMFCRibbonBar`

`CMFCRibbonBar::Create`

`CMFCRibbonBar::CreateEx`

`CMFCRibbonBar::DeactivateKeyboardFocus`

`CMFCRibbonBar::DrawMenuImage`

`CMFCRibbonBar::DWMCompositionChanged`

`CMFCRibbonBar::EnableKeyTips`

`CMFCRibbonBar::EnablePrintPreview`

`CMFCRibbonBar::EnableToolTips`

`CMFCRibbonBar::FindByData`

`CMFCRibbonBar::FindByID`

`CMFCRibbonBar::FindCategoryIndexByData`

`CMFCRibbonBar::ForceRecalcLayout`

`CMFCRibbonBar::GetActiveCategory`

`CMFCRibbonBar::GetApplicationButton`

`CMFCRibbonBar::GetCaptionHeight`

`CMFCRibbonBar::GetCategory`

`CMFCRibbonBar::GetCategoryCount`

`CMFCRibbonBar::GetCategoryHeight`

`CMFCRibbonBar::GetCategoryIndex`

`CMFCRibbonBar::GetContextName`

`CMFCRibbonBar::GetDroppedDown`

`CMFCRibbonBar::GetElementsByID`

`CMFCRibbonBar::GetHideFlags`

`CMFCRibbonBar::GetItemIDsList`

`CMFCRibbonBar::GetKeyboardNavigationLevel`

`CMFCRibbonBar::GetKeyboardNavLevelCurrent`

`CMFCRibbonBar::GetKeyboardNavLevelParent`

`CMFCRibbonBar::GetMainCategory`

`CMFCRibbonBar::GetQATCommandsLocation`

`CMFCRibbonBar::GetQATDroppedDown`

`CMFCRibbonBar::GetQuickAccessCommands`

`CMFCRibbonBar::GetQuickAccessToolbarLocation`

`CMFCRibbonBar::GetTabTrancateRatio`

`CMFCRibbonBar::GetTooltipFixedWidthLargeImage`

`CMFCRibbonBar::GetTooltipFixedWidthRegular`

`CMFCRibbonBar::GetVisibleCategoryCount`