CMFCRibbonGallery-Klasse

Implementiert Menübandkataloge im Stil von Office 2007. Ausführliche Informationen finden Sie im Quellcode des Ordners VC\atlmfc\src\mfc der Visual Studio-Installation.

Syntax

class CMFCRibbonGallery : public CMFCRibbonButton

Member

Öffentliche Konstruktoren

Name	Beschreibung
CMFCRibbonGallery::CMFCRibbonGallery	Erstellt und initialisiert ein CMFCRibbonGallery-Objekt.

Öffentliche Methoden

Name	Beschreibung
CMFCRibbonGallery::AddGroup	Fügt dem Katalog eine neue Gruppe hinzu.
CMFCRibbonGallery::AddSubItem	Fügt dem Dropdownmenü ein neues Menüelement hinzu.
CMFCRibbonGallery::Clear	Löscht den Inhalt des Katalogs.
CMFCRibbonGallery::EnableMenuResize	Aktiviert oder deaktiviert die Größenänderung des Menübereichs.
CMFCRibbonGallery::EnableMenuSideBar	Aktiviert oder deaktiviert die Seitenleiste links neben dem Popupmenü.
CMFCRibbonGallery::GetCompactSize	(Außerkraftsetzungen CMFCRibbonButton::GetCompactSize.)
CMFCRibbonGallery::GetDroppedDown	(Außerkraftsetzungen CMFCRibbonBaseElement::GetDroppedDown.)
CMFCRibbonGallery::GetGroupName	Gibt den Namen der Gruppe zurück, die sich im angegebenen Index befindet.
CMFCRibbonGallery::GetGroupOffset
CMFCRibbonGallery::GetIconsInRow	Gibt die Anzahl der Elemente in einer Zeile des Menübandkatalogs zurück.
CMFCRibbonGallery::GetItemToolTip	Gibt den QuickInfo-Text zurück, der einem Element im Katalog zugeordnet ist.
CMFCRibbonGallery::GetLastSelectedItem	Gibt den Index des letzten Elements im Katalog zurück, den der Benutzer ausgewählt hat.
CMFCRibbonGallery::GetPaletteID	Gibt die Befehls-ID des aktuellen Katalogs zurück.
CMFCRibbonGallery::GetRegularSize	(Außerkraftsetzungen CMFCRibbonButton::GetRegularSize.)
CMFCRibbonGallery::GetSelectedItem
CMFCRibbonGallery::HasMenu	(Außerkraftsetzungen CMFCRibbonButton::HasMenu.)
CMFCRibbonGallery::IsButtonMode	Gibt an, ob der Katalog in einer Katalogschaltfläche enthalten ist.
CMFCRibbonGallery::IsMenuResizeEnabled	Gibt an, ob die Menügröße aktiviert oder deaktiviert ist.
CMFCRibbonGallery::IsMenuResizeVertical
CMFCRibbonGallery::IsMenuSideBar	Gibt an, ob die Seitleiste aktiviert oder deaktiviert ist.
CMFCRibbonGallery::OnAfterChangeRect	(Überschreibt CMFCRibbonButton::OnAfterChangeRect.)
CMFCRibbonGallery::OnDraw	(Außerkraftsetzungen CMFCRibbonButton::OnDraw.)
CMFCRibbonGallery::OnEnable	(Überschreibt CMFCRibbonBaseElement::OnEnable.)
CMFCRibbonGallery::OnRTLChanged	(Außerkraftsetzungen CMFCRibbonBaseElement::OnRTLChanged.)
CMFCRibbonGallery::RedrawIcons	Die Galerie wird neu gezeichnet.
CMFCRibbonGallery::RemoveItemToolTips	Entfernt die QuickInfos aus allen Elementen im Katalog.
CMFCRibbonGallery::SelectItem
CMFCRibbonGallery::SetACCData	(Außerkraftsetzungen CMFCRibbonButton::SetACCData.)
CMFCRibbonGallery::SetButtonMode	Gibt an, ob der Menübandkatalog als Dropdownschaltfläche oder als Palette direkt im Menüband angezeigt werden soll.
CMFCRibbonGallery::SetGroupName	Legt den Namen einer Gruppe fest.
CMFCRibbonGallery::SetIconsInRow	Definiert die Anzahl der Elemente pro Zeile im Katalog.
CMFCRibbonGallery::SetItemToolTip	Legt den QuickInfo-Text für ein Element im Katalog fest.
CMFCRibbonGallery::SetPalette	Fügt eine Palette an einen Menübandkatalog an.
CMFCRibbonGallery::SetPaletteID	Definiert die Befehls-ID, die in der WM_COMMAND Nachricht gesendet wird, wenn ein Katalogelement ausgewählt wurde.

Geschützte Methoden

Name	Beschreibung
CMFCRibbonGallery::OnDrawPaletteIcon	Wird vom Framework aufgerufen, wenn ein Katalogsymbol gezeichnet wird.

Hinweise

Eine Katalogschaltfläche verhält sich genauso wie eine normale Menüschaltfläche, mit der Ausnahme, dass ein Katalog angezeigt wird, wenn ein Benutzer ihn öffnet. Wenn Sie ein Element in einem Katalog auswählen, sendet das Framework die WM_COMMAND Nachricht zusammen mit der Befehls-ID der Schaltfläche. Wenn Sie die Nachricht behandeln, sollten Sie CMFCRibbonGallery::GetLastSelectedItem aufrufen, um zu bestimmen, welches Element aus dem Katalog ausgewählt wurde.

Beispiel

Im folgenden Beispiel wird veranschaulicht, wie verschiedene Methoden in der CMFCRibbonGallery Klasse zum Konfigurieren eines CMFCRibbonGallery Objekts verwendet werden. Das Beispiel veranschaulicht, wie Sie die Anzahl der Elemente pro Zeile im Katalog angeben, die Größe des Menübereichs ändern, die Seitenleiste links neben dem Popupmenü aktivieren und den Menübandkatalog als Palette direkt auf der Menübandleiste anzeigen. Dieser Codeausschnitt ist Teil des Draw Client-Beispiels.

CMFCRibbonGallery *pBtnStyles = new CMFCRibbonGallery(ID_OBJECT_STYLES, _T("Styles\nk"), 0, 0, IDB_STYLES, 40);
pBtnStyles->SetIconsInRow(7);
pBtnStyles->EnableMenuResize(TRUE, TRUE);
pBtnStyles->EnableMenuSideBar();
pBtnStyles->SetButtonMode(false);
pBtnStyles->RedrawIcons();

Vererbungshierarchie

CObject
└ CMFCRibbonBaseElement
 └ CMFCRibbonButton
  └ CMFCRibbonGallery

Anforderungen

Kopfzeile: afxRibbonPaletteGallery.h

CMFCRibbonGallery::AddGroup

Fügt dem Katalog eine neue Gruppe hinzu.

void AddGroup(
    LPCTSTR lpszGroupName,
    UINT uiImagesPaletteResID,
    int cxPaletteImage);

void AddGroup(
    LPCTSTR lpszGroupName,
    CMFCToolBarImages& imagesGroup);

void AddGroup(
    LPCTSTR lpszGroupName,
    int nIconsNum);

Parameter

lpszGroupName
[in] Gibt den Namen der Gruppe an.

uiImagesPaletteResID
[in] Gibt die Ressourcen-ID der Bildliste an, die die Bilder für die Gruppe enthält.

cxPaletteImage
[in] Gibt die Breite in Pixeln eines Bilds an.

imagesGroup
[in] Ein Verweis auf die Bildliste, die Gruppenbilder enthält.

nIconsNum
[in] Gibt die Anzahl der Symbole in der Gruppe an. Dieser Parameter sollte nur für benutzerdefinierte (besitzergezeichnete) Gruppen angegeben werden.

Hinweise

Sie können die Elemente in einem Menübandkatalog in mehrere Gruppen unterteilen, indem Sie diese Methode aufrufen. Jede Gruppe kann eine Beschriftung haben.

CMFCRibbonGallery::AddSubItem

Fügt dem Dropdownmenü ein neues Menüelement hinzu.

void AddSubItem(
    CMFCRibbonBaseElement* pSubItem,
    int nIndex=-1,
    BOOL bOnTop=FALSE);

Parameter

pSubItem
[in] Ein Zeiger auf das Element, das dem Menü hinzugefügt werden soll.

nIndex
[in] Gibt den nullbasierten Index einer Position an, an der das Element eingefügt werden soll.

bOnTop
[in] TRUE, um anzugeben, dass das Element vor dem Menübandkatalog eingefügt werden soll; andernfalls FALSE.

Hinweise

Sie können Popupkataloge mit Popupmenüelementen kombinieren, indem Sie diese Methode aufrufen. Menüelemente können vor oder nach dem Katalog platziert werden.

Wenn Sie das Element vor dem Katalog einfügen möchten, legen Sie "bOnTop " auf TRUE fest. Legen Sie "bOnTop " auf FALSE fest, um das Element unterhalb des Katalogs einzufügen.

Hinweis

Der Parameter nIndex gibt den Einfügeindex sowohl am oberen Rand des Katalogs als auch am unteren Rand des Katalogs an. Wenn Sie beispielsweise ein Element vor dem Katalog einfügen müssen, legen Sie "nIndex " auf 1 und "bOnTop " auf "TRUE" fest. Wenn Sie ein Element an einer Position unterhalb des Katalogs einfügen müssen, legen Sie "nIndex " auf "1" und "bOnTop " auf "FALSE" fest.

CMFCRibbonGallery::Clear

Löscht den Inhalt des Katalogs.

virtual void Clear();

Hinweise

Rufen Sie diese Methode auf, um alle Inhalte aus dem Menübandkatalog zu entfernen. Dies muss erfolgen, bevor Sie einen neuen Menübandkatalog oder eine Gruppe von Gruppen an den Menübandkatalog anfügen.

CMFCRibbonGallery::CMFCRibbonGallery

Erstellt und initialisiert ein CMFCRibbonGallery -Objekt.

CMFCRibbonGallery (
    UINT nID,
    LPCTSTR lpszText,
    int nSmallImageIndex,
    int nLargeImageIndex,
    CMFCToolBarImages& imagesPalette);

CMFCRibbonGallery (
    UINT nID,
    LPCTSTR lpszText,
    int nSmallImageIndex,
    int nLargeImageIndex,
    UINT uiImagesPaletteResID=0,
    int cxPaletteImage=0);

CMFCRibbonGallery (
    UINT nID,
    LPCTSTR lpszText,
    int nSmallImageIndex,
    int nLargeImageIndex,
    CSize sizeIcon,
    int nIconsNum,
    BOOL bDefaultButtonStyle=TRUE);

Parameter

Nid
Gibt die Befehls-ID des auszuführenden Befehls an, wenn ein Benutzer auf die Schaltfläche klickt.

lpszText
Gibt den Text an, der auf der Schaltfläche angezeigt werden soll.

nSmallImageIndex
Der nullbasierte Index des kleinen Bilds, das auf der Schaltfläche angezeigt werden soll.

nLargeImageIndex
Der nullbasierte Index des großen Bilds, das auf der Schaltfläche angezeigt werden soll.

imagesPalette
Ein Verweis auf das CMFCToolBarImages -Objekt, das die Bilder enthält, die im Katalog angezeigt werden sollen.

uiImagesPaletteResID
Die Ressourcen-ID der Liste der Bilder, die im Katalog angezeigt werden sollen.

cxPaletteImage
Gibt die Breite des Bilds im Katalog in Pixel an.

sizeIcon
Gibt die Größe des Katalogbilds in Pixel an.

nIconsNum
Gibt die Anzahl der Symbole im Katalog an.

bDefaultButtonStyle
Gibt an, ob die Standard- oder die Vom Besitzer gezeichnete Schaltflächenformatvorlage verwendet werden soll.

Hinweise

CMFCRibbonGallery::EnableMenuResize

Aktiviert oder deaktiviert die Größenänderung des Menübereichs.

void EnableMenuResize(
    BOOL bEnable = TRUE,
    BOOL bVertcalOnly = FALSE);

Parameter

bEnable
[in] TRUE, um die Größe des Menüs zu aktivieren; andernfalls FALSE.

bVertcalOnly
[in] TRUE, um anzugeben, dass die Größe des Katalogs nur vertikal geändert werden kann; FALSE, um anzugeben, dass die Größe des Katalogs vertikal und horizontal geändert werden kann.

Hinweise

Verwenden Sie diese Methode, um die Größe des Menübandkatalogs zu aktivieren oder zu deaktivieren. Wenn die Größenänderung aktiviert ist, zeigt der Menübandkatalog ein Ziehelement an, das ein Benutzer zum Ändern der Größe verwenden kann.

CMFCRibbonGallery::EnableMenuSideBar

Aktiviert oder deaktiviert die Seitenleiste links neben dem Popupmenü.

void EnablMenuSideBar(BOOL bEnable=TRUE);

Parameter

bEnable
[in] TRUE, um anzugeben, dass die Seitleiste aktiviert ist; andernfalls FALSE.

Hinweise

Rufen Sie diese Methode auf, um die Office XP-Seitenleiste auf der linken Seite des Menüs zu aktivieren oder zu deaktivieren.

CMFCRibbonGallery::GetCompactSize

virtual CSize GetCompactSize(CDC* pDC);

Parameter

[in] pDC

Rückgabewert

Bemerkungen

CMFCRibbonGallery::GetDroppedDown

virtual CMFCRibbonBaseElement* GetDroppedDown();

Rückgabewert

Bemerkungen

CMFCRibbonGallery::GetGroupName

Gibt den Namen der Gruppe zurück, die sich im angegebenen Index befindet.

LPCTSTR GetGroupName(int nGroupIndex) const;

Parameter

nGroupIndex
[in] Gibt den nullbasierten Index für die Gruppe an, deren Name Sie abrufen möchten.

Rückgabewert

Der Name der Gruppe, die sich am angegebenen Index befindet. Das Übergeben eines ungültigen Indexes führt zu einer fehlgeschlagenen Assertion.

Hinweise

CMFCRibbonGallery::GetGroupOffset

virtual int GetGroupOffset() const;

Rückgabewert

Bemerkungen

CMFCRibbonGallery::GetIconsInRow

Gibt die Anzahl der Elemente in einer Zeile des Menübandkatalogs zurück.

int GetIconsInRow() const;

Rückgabewert

Die Anzahl der Elemente in einer Zeile.

Hinweise

CMFCRibbonGallery::GetItemToolTip

Gibt den QuickInfo-Text zurück, der einem Element im Katalog zugeordnet ist.

LPCTSTR GetItemToolTip(int nItemIndex) const;

Parameter

nItemIndex
[in] Gibt den nullbasierten Index des Elements an, für das der QuickInfo-Text abgerufen werden soll.

Rückgabewert

Ein Zeiger auf die QuickInfo-Zeichenfolge, die einem Element im Menübandkatalog zugewiesen ist. Er kann NULL sein, wenn diesem Element keine QuickInfo zugewiesen ist.

Hinweise

CMFCRibbonGallery::GetLastSelectedItem

Gibt den Index des letzten Elements im Menübandkatalog zurück, den der Benutzer ausgewählt hat.

static int GetLastSelectedItem(UINT uiCmdID);

Parameter

uiCmdID
[in] Gibt die Befehls-ID des Menüelements an, das den Menübandkatalog geöffnet hat.

Rückgabewert

Wenn der Benutzer ein Element im Menübandkatalog auswählt, sendet die Bibliothek die WM_COMMAND Nachricht zusammen mit der Befehls-ID der Menüschaltfläche, die den Menübandkatalog geöffnet hat.

Hinweise

CMFCRibbonGallery::GetPaletteID

Gibt die Befehls-ID der aktuellen Palette zurück.

int GetPaletteID() const;

Rückgabewert

Die Befehls-ID der aktuell ausgewählten Palette.

Hinweise

CMFCRibbonGallery::GetRegularSize

virtual CSize GetRegularSize(CDC* pDC);

Parameter

[in] pDC

Rückgabewert

Bemerkungen

CMFCRibbonGallery::GetSelectedItem

int GetSelectedItem() const;

Rückgabewert

Bemerkungen

CMFCRibbonGallery::HasMenu

virtual BOOL HasMenu() const;

Rückgabewert

Bemerkungen

CMFCRibbonGallery::IsButtonMode

Gibt an, ob die Palette in einer Katalogschaltfläche enthalten ist.

BOOL IsButtonMode() const;

Rückgabewert

TRUE, wenn die Palette als Dropdownmenüschaltfläche angezeigt wird; FALSE, wenn die Palette direkt im Menüband angezeigt wird.

Hinweise

CMFCRibbonGallery::IsMenuResizeEnabled

Gibt an, ob die Menügröße aktiviert ist.

BOOL IsMenuResizeEnabled() const;

Rückgabewert

TRUE, wenn die Menügröße aktiviert wurde; andernfalls FALSE.

Hinweise

CMFCRibbonGallery::IsMenuResizeVertical

BOOL IsMenuResizeVertical() const;

Rückgabewert

Bemerkungen

CMFCRibbonGallery::IsMenuSideBar

Gibt an, ob die Seitleiste aktiviert oder deaktiviert ist.

BOOL IsMenuSideBar() const;

Rückgabewert

TRUE, wenn die Seitenleiste im Office XP-Stil auf der linken Seite des Popupmenüs gezeichnet wird; andernfalls FALSE.

Hinweise

CMFCRibbonGallery::OnAfterChangeRect

virtual void OnAfterChangeRect(CDC* pDC);

Parameter

[in] pDC

Hinweise

CMFCRibbonGallery::OnDraw

virtual void OnDraw(CDC* pDC);

Parameter

[in] pDC

Hinweise

CMFCRibbonGallery::OnDrawPaletteIcon

Wird vom Framework aufgerufen, wenn ein Katalogsymbol gezeichnet wird.

virtual void OnDrawPaletteIcon(
    CDC* pDC,
    CRect rectIcon,
    int nIconIndex,
    CMFCRibbonGalleryIcon* pIcon,
    COLORREF clrText);

Parameter

pDC
[in] Ein Zeiger auf den Gerätekontext, der für die Zeichnung verwendet wird.

rectIcon
[in] Gibt das umgebende Rechteck des zu zeichnenden Symbols an.

nIconIndex
[in] Gibt den nullbasierten Index in der Bildliste der Katalogsymbole des zu zeichnenden Symbols an.

pIcon
[in] Ein Zeiger auf das Symbol, das gezeichnet wird.

clrText
[in] Gibt die Farbe für den Text des zu zeichnenden Elements an.

Hinweise

Sie können diese Methode in einer abgeleiteten Klasse überschreiben, um die Darstellung eines Menübandkatalogs anzupassen.

CMFCRibbonGallery::OnEnable

virtual void OnEnable(BOOL bEnable);

Parameter

[in] bEnable

Hinweise

CMFCRibbonGallery::OnRTLChanged

virtual void OnRTLChanged(BOOL bIsRTL);

Parameter

[in] bIsRTL

Hinweise

CMFCRibbonGallery::RedrawIcons

Die Galerie wird neu gezeichnet.

void RedrawIcons();

Hinweise

Rufen Sie diese Funktion auf, um den Katalog neu zu zeichnen. Sie müssen diese Methode aufrufen, wenn Sie den Inhalt des Katalogs zur Laufzeit geändert haben.

CMFCRibbonGallery::RemoveItemToolTips

Entfernt die QuickInfos aus allen Elementen im Katalog.

void RemoveItemToolTips();

Hinweise

CMFCRibbonGallery::SelectItem

void SelectItem(int nItemIndex);

Parameter

[in] nItemIndex

Hinweise

CMFCRibbonGallery::SetACCData

Füllt das angegebene CAccessibilityData -Objekt mithilfe von Barrierefreiheitsdaten aus dem Menübandkatalog.

virtual BOOL SetACCData(
    CWnd* pParent,
    CAccessibilityData& data);

Parameter

pParent
[in] Das übergeordnete Fenster des Menübandkatalogfensters.

data
[out] Ein CAccessibilityData Objekt, das die Barrierefreiheitsdaten aus dem Menübandkatalog empfängt.

Rückgabewert

Bemerkungen

TRUE, wenn die Methode erfolgreich ist; andernfalls FALSE.

CMFCRibbonGallery::SetButtonMode

Bestimmt, ob der Menübandkatalog als Dropdownschaltfläche oder als Palette direkt im Menüband angezeigt werden soll.

void SetButtonMode(BOOL bSet=TRUE);

Parameter

bSet
[in] TRUE, um den Menübandkatalog als Dropdownmenüschaltfläche anzuzeigen; FALSE, um den Inhalt des Menübandkatalogs direkt im Menüband anzuzeigen.

Hinweise

CMFCRibbonGallery::SetGroupName

Legt den Namen einer Gruppe fest.

void SetGroupName(
    int nGroupIndex,
    LPCTSTR lpszGroupName);

Parameter

nGroupIndex
[in] Gibt den nullbasierten Index für die Gruppe an, für die der Name geändert wird.

lpszGroupName
[in] Gibt den neuen Namen für die Gruppe an.

Hinweise

Die Gruppe, deren Name geändert wird, muss mithilfe der CMFCRibbonGallery::AddGroup-Methode hinzugefügt worden sein.

CMFCRibbonGallery::SetIconsInRow

Gibt die Anzahl der Elemente pro Zeile im Katalog an.

void SetIconsInRow(int nIconsInRow);

Parameter

nIconsInRow
[in] Gibt die Anzahl der Elemente an, die in jeder Zeile des Katalogs angezeigt werden sollen.

Hinweise

Verwenden Sie diese Methode, um die Breite des Menübandkatalogs anzugeben.

CMFCRibbonGallery::SetItemToolTip

Legt den QuickInfo-Text für ein Element im Katalog fest.

void SetItemToolTip(
    int nItemIndex,
    LPCTSTR lpszToolTip);

Parameter

nItemIndex
[in] Der nullbasierte Index des Palettenelements, dem die QuickInfo zugeordnet werden soll.

lpszToolTip
[in] Der Text, der auf der QuickInfo angezeigt werden soll.

Hinweise

CMFCRibbonGallery::SetPalette

Fügt eine Palette an einen Menübandkatalog an.

void SetPalette(CMFCToolBarImages& imagesPalette);

void SetPalette(
    UINT uiImagesPaletteResID,
    int cxPaletteImage);

Parameter

imagesPalette
[in] Gibt die Bildliste an, die die Symbole enthält, die im Katalog angezeigt werden sollen.

uiImagesPaletteResID
[in] Gibt die Ressourcen-ID der Bildliste an, die die Symbole enthält, die im Katalog angezeigt werden sollen.

cxPaletteImage
[in] Gibt die Breite eines Bilds im Katalog in Pixel an.

Hinweise

CMFCRibbonGallery::SetPaletteID

Definiert die Befehls-ID, die in der WM_COMMAND Nachricht gesendet wird, wenn ein Benutzer ein Katalogelement auswählt.

void SetPaletteID(UINT nID);

Parameter

Nid
[in] Gibt die Befehls-ID an, die in der WM_COMMAND Nachricht gesendet wird, wenn ein Benutzer ein Katalogelement auswählt.

Hinweise

Um das bestimmte Element zu ermitteln, das ein Benutzer aus dem Katalog ausgewählt hat, rufen Sie die statische CMFCRibbonGallery::GetLastSelectedItem-Methode auf.

Siehe auch

Hierarchiediagramm
Klassen
CMFCRibbonButton-Klasse
CMFCRibbonGalleryMenuButton-Klasse