CMFCRibbonCategory-Klasse

Die CMFCRibbonCategory Klasse implementiert eine Menübandregisterkarte, die eine Gruppe von Menübandbereichen enthält.

Syntax

class CMFCRibbonCategory : public CObject

Member

Geschützte Konstruktoren

Name Beschreibung
CMFCRibbonCategory::CMFCRibbonCategory Der Konstruktor.

Öffentliche Methoden

Name Beschreibung
CMFCRibbonCategory::AddHidden Fügt der Menübandkategorie ein ausgeblendetes Element hinzu.
CMFCRibbonCategory::AddPanel Fügt der Menübandkategorie einen neuen Bereich hinzu.
CMFCRibbonCategory::CopyFrom
CMFCRibbonCategory::FindByData
CMFCRibbonCategory::FindByID
CMFCRibbonCategory::FindPanelWithElem
CMFCRibbonCategory::GetContextID Gibt die Kontext-ID der Menübandkategorie zurück.
CMFCRibbonCategory::GetData Gibt die benutzerdefinierten Daten zurück, die der Menübandkategorie zugeordnet sind.
CMFCRibbonCategory::GetDroppedDown
CMFCRibbonCategory::GetElements
CMFCRibbonCategory::GetElementsByID
CMFCRibbonCategory::GetFirstVisibleElement Rufen Sie ein erstes sichtbares Element ab, das zur Menübandkategorie gehört.
CMFCRibbonCategory::GetFocused Gibt ein Fokuselement zurück.
CMFCRibbonCategory::GetHighlighted Gibt ein hervorgehobenes Element zurück.
CMFCRibbonCategory::GetImageCount
CMFCRibbonCategory::GetImageSize
CMFCRibbonCategory::GetItemIDsList
CMFCRibbonCategory::GetLastVisibleElement Abrufen eines letzten sichtbaren Elements, das zur Menübandkategorie gehört
CMFCRibbonCategory::GetLargeImages Gibt einen Verweis auf die Liste der großen Bilder zurück, die von der Menübandkategorie verwendet werden.
CMFCRibbonCategory::GetMaxHeight
CMFCRibbonCategory::GetName
CMFCRibbonCategory::GetPanel Gibt einen Zeiger auf den Menübandbereich zurück, der sich am angegebenen Index befindet.
CMFCRibbonCategory::GetPanelCount Gibt die Anzahl der Menübandbereiche in der Menübandkategorie zurück.
CMFCRibbonCategory::GetPanelFromPoint
CMFCRibbonCategory::GetPanelIndex Gibt den Index des angegebenen Menübandpanels zurück.
CMFCRibbonCategory::GetParentButton
CMFCRibbonCategory::GetParentMenuBar
CMFCRibbonCategory::GetParentRibbonBar
CMFCRibbonCategory::GetRect
CMFCRibbonCategory::GetSmallImages Gibt einen Verweis auf die Liste der kleinen Bilder zurück, die von der Kategorie verwendet werden.
CMFCRibbonCategory::GetTabColor Gibt die aktuelle Farbe der Registerkarte "Kategorie" des Menübands zurück.
CMFCRibbonCategory::GetTabRect
CMFCRibbonCategory::GetTextTopLine
CMFCRibbonCategory::GetVisibleElements Rufen Sie alle sichtbaren Elemente ab, die zur Menübandkategorie gehören.
CMFCRibbonCategory::HighlightPanel
CMFCRibbonCategory::HitTest
CMFCRibbonCategory::HitTestEx
CMFCRibbonCategory::HitTestScrollButtons
CMFCRibbonCategory::IsActive
CMFCRibbonCategory::IsVisible Bestimmt, ob die Menübandkategorie sichtbar ist.
CMFCRibbonCategory::IsWindows7Look Gibt an, ob das übergeordnete Menüband das Windows 7-Format aufweist (kleine rechteckige Anwendungsschaltfläche)
CMFCRibbonCategory::NotifyControlCommand
CMFCRibbonCategory::OnCancelMode
CMFCRibbonCategory::OnDraw
CMFCRibbonCategory::OnDrawImage
CMFCRibbonCategory::OnDrawMenuBorder
CMFCRibbonCategory::OnKey Wird vom Framework aufgerufen, wenn ein Benutzer eine Tastaturtaste drückt.
CMFCRibbonCategory::OnLButtonDown
CMFCRibbonCategory::OnLButtonUp
CMFCRibbonCategory::OnMouseMove
CMFCRibbonCategory::OnRTLChanged
CMFCRibbonCategory::OnScrollHorz
CMFCRibbonCategory::OnUpdateCmdUI
CMFCRibbonCategory::RecalcLayout
CMFCRibbonCategory::RemovePanel
CMFCRibbonCategory::ReposPanels
CMFCRibbonCategory::SetCollapseOrder Definiert die Reihenfolge zum Reduzieren der Menübandbereiche, die in der Menübandkategorie vorhanden sind.
CMFCRibbonCategory::SetData Speichert die benutzerdefinierten Daten in der Menübandkategorie.
CMFCRibbonCategory::SetKeys Weist der Menübandkategorie eine Zugriffstasteninfo zu.
CMFCRibbonCategory::SetName
CMFCRibbonCategory::SetTabColor Legt die Farbe der Menübandkategorie fest.

Hinweise

In der Regel erstellen Sie eine Menübandkategorie indirekt durch Aufrufen von CMFCRibbonBar::AddCategory, das einen Zeiger auf die neu erstellte Menübandkategorie zurückgibt. Sie fügen der Kategorie Panels hinzu, indem Sie CMFCRibbonCategory::AddPanel aufrufen.

Die CMFCRibbonTab Klasse zeichnet Menübandkategorien. Sie wird von der CMFCRibbonBaseElement-Klasse abgeleitet.

In diesem folgenden Beispiel wird veranschaulicht, wie Sie eine Menübandkategorie erstellen und ihr einen Bereich hinzufügen.

// Create a new ribbon category and get a pointer to it`
CMFCRibbonCategory* pCategory = m_wndRibbonBar.AddCategory
    (_T("&Write"),           // Category name
    IDB_WRITE,               // Category small images (16 x 16)
    IDB_WRITE_LARGE);        // Category large images (32 x 32)

// Add a panel to the new category
CMFCRibbonPanel* pPanel = pCategory->AddPanel (
    _T("Clipboard"),                // Panel name
    m_PanelIcons.ExtractIcon (0));  // Panel icon

Das folgende Diagramm zeigt eine Abbildung der Kategorie "Start" aus der RibbonApp-Beispielanwendung.

Kategorie

Vererbungshierarchie

CObject

CMFCRibbonCategory

Anforderungen

Kopfzeile: afxribboncategory.h

CMFCRibbonCategory::AddHidden

Fügt das angegebene Menübandelement dem Array von Menübandelementen hinzu, die im Dialogfeld "Anpassung" angezeigt werden.

void AddHidden(CMFCRibbonBaseElement* pElem);

Parameter

pElem
[in] Zeiger auf ein Menübandelement.

Hinweise

Menübandelemente im Dialogfeld "Anpassung" sind die Befehle, die Sie der Symbolleiste für den Schnellzugriff hinzufügen können.

CMFCRibbonCategory::AddPanel

Erstellt einen Menübandbereich für die Menübandkategorie.

CMFCRibbonPanel* AddPanel(
    LPCTSTR lpszPanelName,
    HICON hIcon = 0,
    CRuntimeClass* pRTI = NULL);

Parameter

lpszPanelName
[in] Zeigen Sie auf den Namen des neuen Menübandbereichs.

hIcon
[in] Behandeln Sie das Standardsymbol für den neuen Menübandbereich.

pRTI
[in] Zeiger auf Laufzeitklasseninformationen für einen benutzerdefinierten Menübandbereich.

Rückgabewert

Zeigen Sie auf den neuen Menübandbereich, wenn die Methode erfolgreich war; andernfalls NULL, wenn das Panel nicht erstellt wurde.

Hinweise

Wenn Sie ein benutzerdefiniertes Menübandpanel erstellen möchten, müssen Sie die Laufzeitklasseninformationen in pRTI angeben. Die benutzerdefinierte Menübandpanelklasse muss von der CMFCRibbonPanel Klasse abgeleitet werden.

Das Standardsymbol für den Menübandbereich wird angezeigt, wenn nicht genügend Platz zum Anzeigen der Menübandelemente vorhanden ist.

Beispiel

Im folgenden Beispiel wird die Verwendung der AddPanel Methode in der CMFCRibbonCategory Klasse veranschaulicht.

// Create "Favorites" panel:
strTemp.LoadString(IDS_RIBBON_FAVORITES);
// CMFCRibbonCategory* pCategoryCustom
CMFCRibbonPanel *pPanelFavorites = pCategoryCustom->AddPanel(strTemp,
                                                             m_PanelImages.ExtractIcon(15));

CMFCRibbonCategory::CMFCRibbonCategory

Erstellt und initialisiert ein CMFCRibbonCategory -Objekt.

CMFCRibbonCategory(
    CMFCRibbonBar* pParenrRibbonBar,
    LPCTSTR lpszName,
    UINT uiSmallImagesResID,
    UINT uiLargeImagesResID,
    CSize sizeSmallImage = CSize(16,
    16),
    CSize sizeLargeImage = CSize(32,
    32));

Parameter

pParenrRibbonBar
[in] Zeigen Sie auf die übergeordnete Menübandleiste der Menübandkategorie.

lpszName
[in] Name der Menübandkategorie.

uiSmallImagesResID
[in] Ressourcen-ID der Bildliste für kleine Bilder, die von Menübandelementen in der Menübandkategorie verwendet werden.

uiLargeImagesResID
[in] Ressourcen-ID der Bildliste für große Bilder, die von Menübandelementen in der Menübandkategorie verwendet werden.

sizeSmallImage
[in] Standardgröße kleiner Bilder für Menübandelemente in der Menübandkategorie.

sizeLargeImage
[in] Standardgröße großer Bilder für Menübandelemente in der Menübandkategorie.

CMFCRibbonCategory::CopyFrom

Kopiert den Status der angegebenen CMFCRibbonCategory in das aktuelle CMFCRibbonCategory -Objekt.

virtual void CopyFrom(CMFCRibbonCategory& src);

Parameter

src
[in] Das Quellobjekt CMFCRibbonCategory .

Hinweise

CMFCRibbonCategory::FindByData

Ruft das Menübandelement ab, das den angegebenen Daten zugeordnet ist.

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

Parameter

dwData
[in] Die daten, die einem Menübandelement zugeordnet sind.

bVisibleOnly
[in] TRUE, um Menübandelemente für den Schnellzugriff in die Suche einzuschließen; FALSE, um Menübandelemente für den Schnellzugriff in der Suche auszuschließen.

Rückgabewert

Zeigen Sie auf ein Menübandelement, wenn die Methode erfolgreich war; andernfalls NULL.

Hinweise

CMFCRibbonCategory::FindByID

Ruft das Menübandelement ab, das der angegebenen Befehls-ID zugeordnet ist.

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

Parameter

uiCmdID
[in] Befehls-ID, die einem Menübandelement zugeordnet ist.

bVisibleOnly
[in] TRUE, um Menübandelemente für den Schnellzugriff in die Suche einzuschließen; FALSE, um Menübandelemente für den Schnellzugriff in der Suche auszuschließen.

Rückgabewert

Zeigen Sie auf ein Menübandelement, wenn die Methode erfolgreich war; andernfalls NULL.

Hinweise

CMFCRibbonCategory::FindPanelWithElem

Ruft den Menübandbereich ab, der das angegebene Menübandelement enthält.

CMFCRibbonPanel* FindPanelWithElem(const CMFCRibbonBaseElement* pElement);

Parameter

pElement
[in] Zeiger auf ein Menübandelement.

Rückgabewert

Zeigen Sie auf ein Menübandpanel, wenn die Methode erfolgreich war; andernfalls NULL.

Hinweise

CMFCRibbonCategory::GetContextID

Ruft die Kontext-ID der Menübandkategorie ab.

UINT GetContextID() const;

Rückgabewert

Kontext-ID der Menübandkategorie.

Hinweise

Die Kontext-ID ist 0, wenn die Menübandkategorie keine Kontextmenübandkategorie ist.

CMFCRibbonCategory::GetData

Ruft die benutzerdefinierten Daten ab, die der Menübandkategorie zugeordnet sind.

DWORD_PTR GetData() const;

Rückgabewert

Die benutzerdefinierten Daten, die der Menübandkategorie zugeordnet sind.

CMFCRibbonCategory::GetDroppedDown

Ruft einen Zeiger auf das Menübandelement ab, das derzeit das Popupmenü anzeigt.

CMFCRibbonBaseElement* GetDroppedDown();

Rückgabewert

Zeigen Sie auf ein Menübandelement, wenn die Methode erfolgreich war; andernfalls NULL.

Hinweise

CMFCRibbonCategory::GetElements

Ruft alle Menübandelemente in der Menübandkategorie ab.

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

Parameter

arElements
[in, out] Verweisen auf ein CArray von Menübandelementen.

Hinweise

Menübandelemente, die auf der Symbolleiste für den Schnellzugriff verwendet werden sollen, sind im Array enthalten.

CMFCRibbonCategory::GetElementsByID

Ruft alle Menübandelemente ab, die der angegebenen Befehls-ID zugeordnet sind.

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

Parameter

uiCmdID
[in] Befehls-ID, die einem Menübandelement zugeordnet ist.

arElements
[in, out] Verweisen auf ein CArray von Menübandelementen.

Hinweise

Menübandelemente, die auf der Symbolleiste für den Schnellzugriff verwendet werden sollen, sind im Array enthalten.

CMFCRibbonCategory::GetFirstVisibleElement

Ruft das erste sichtbare Element ab, das zur Menübandkategorie gehört.

CMFCRibbonBaseElement* GetFirstVisibleElement() const;

Rückgabewert

Zeiger auf das erste sichtbare Element; kann NULL sein, wenn die Kategorie keine sichtbaren Elemente enthält.

Hinweise

CMFCRibbonCategory::GetFocused

Gibt ein Fokuselement zurück.

CMFCRibbonBaseElement* GetFocused();

Rückgabewert

Ein Zeiger auf ein fokussiertes Element oder NULL.

Hinweise

CMFCRibbonCategory::GetHighlighted

Gibt ein hervorgehobenes Element zurück.

CMFCRibbonBaseElement* GetHighlighted();

Rückgabewert

Ein Zeiger auf ein hervorgehobenes Element oder NULL, wenn keine Elemente hervorgehoben sind.

Hinweise

CMFCRibbonCategory::GetImageCount

Ruft die Anzahl der Bilder in der angegebenen Bildliste ab, die in der Menübandkategorie enthalten ist.

int GetImageCount(BOOL bIsLargeImage) const;

Parameter

bIsLargeImage
[in] TRUE für die Anzahl der Bilder in der großen Bildliste; FALSE für die Anzahl der Bilder in der kleinen Bildliste.

Rückgabewert

Die Anzahl der Bilder in der angegebenen Bildliste.

Hinweise

CMFCRibbonCategory::GetImageSize

Ruft die Größe eines Bilds in der angegebenen Bildliste ab, die in der Menübandkategorie enthalten ist.

CSize GetImageSize(BOOL bIsLargeImage) const;

Parameter

bIsLargeImage
[in] TRUE für die Größe großer Bilder; FALSE für die Größe kleiner Bilder.

Rückgabewert

Die Größe eines Bilds in der angegebenen Bildliste.

Hinweise

Die abgerufene Größe enthält den globalen Bildskalierungsfaktor.

CMFCRibbonCategory::GetItemIDsList

Ruft die Befehls-IDs für die Menübandelemente ab, die in der Menübandkategorie enthalten sind.

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

Parameter

lstItems
[out] Die Liste der Befehls-IDs für die Menübandelemente in der Menübandkategorie.

bHiddenOnly
[in] TRUE, um Menübandelemente auszuschließen, die in den Menübandbereichen in der Menübandkategorie angezeigt werden; FALSE, um alle Menübandelemente in die Menübandkategorie einzuschließen.

Hinweise

CMFCRibbonCategory::GetLargeImages

Ruft die Liste der großen Bilder ab, die in der Menübandkategorie enthalten sind.

CMFCToolBarImages& GetLargeImages();

Rückgabewert

Die Liste der großen Bilder, die in der Menübandkategorie enthalten sind.

CMFCRibbonCategory::GetLastVisibleElement

Ruft das letzte sichtbare Element ab, das zur Menübandkategorie gehört.

CMFCRibbonBaseElement* GetLastVisibleElement() const;

Rückgabewert

Zeiger auf das letzte sichtbare Element; kann NULL sein, wenn die Kategorie keine sichtbaren Elemente enthält.

Hinweise

CMFCRibbonCategory::GetMaxHeight

Ruft die maximale Höhe der Menübandbereiche ab, die in der Menübandkategorie enthalten sind.

int GetMaxHeight(CDC* pDC);

Parameter

pDC
[in] Zeigen Sie auf einen Gerätekontext für die Menübandbereiche.

Rückgabewert

Die maximale Höhe der Menübandbereiche, die in der Menübandkategorie enthalten sind.

Hinweise

Der abgerufene Wert enthält die Höhe der oberen und unteren Seitenränder für die Menübandbereiche.

CMFCRibbonCategory::GetName

Ruft den Namen der Menübandkategorie ab.

LPCTSTR GetName() const;

Rückgabewert

Der Name der Menübandkategorie.

Hinweise

CMFCRibbonCategory::GetPanel

Gibt einen Zeiger auf den Menübandbereich zurück, der sich am angegebenen Index befindet.

CMFCRibbonPanel* GetPanel(int nIndex);

Parameter

nIndex
[in] Der nullbasierte Index eines Menübandpanels.

Rückgabewert

Zeigen Sie auf den Menübandbereich, der sich am angegebenen Index befindet.

Hinweise

Eine Ausnahme wird ausgelöst, wenn nIndex außerhalb des Bereichs liegt.

CMFCRibbonCategory::GetPanelCount

Gibt die Anzahl der Menübandbereiche in der Menübandkategorie zurück.

int GetPanelCount() const;

Rückgabewert

Die Anzahl der Menübandbereiche in der Menübandkategorie.

CMFCRibbonCategory::GetPanelFromPoint

Ruft einen Zeiger auf einen Menübandbereich ab, wenn sich der angegebene Punkt darin befindet.

CMFCRibbonPanel* GetPanelFromPoint(CPoint point) const;

Parameter

Punkt
[in] Die X- und Y-Koordinaten des Zeigers relativ zur oberen linken Ecke des Fensters.

Rückgabewert

Zeigen Sie auf ein Menübandpanel, wenn die Methode erfolgreich war; andernfalls NULL.

Hinweise

Es werden nur Menübandbereiche getestet, die in der Menübandkategorie enthalten sind.

CMFCRibbonCategory::GetPanelIndex

Ruft den nullbasierten Index des angegebenen Menübandpanels ab.

int GetPanelIndex(const CMFCRibbonPanel* pPanel) const;

Parameter

pPanel
[in] Zeiger auf einen Menübandbereich.

Rückgabewert

Nullbasierter Index des angegebenen Menübandpanels, wenn die Methode erfolgreich war; andernfalls -1.

Hinweise

Es werden nur Menübandbereiche durchsucht, die in der Menübandkategorie enthalten sind.

CMFCRibbonCategory::GetParentButton

Ruft das übergeordnete Menübandelement der Menübandkategorie ab.

CMFCRibbonBaseElement* GetParentButton() const;

Rückgabewert

Gibt einen Zeiger auf das übergeordnete Menübandelement oder NULL zurück, wenn kein übergeordnetes Element vorhanden ist.

Hinweise

CMFCRibbonCategory::GetParentMenuBar

Gibt einen Zeiger auf die übergeordnete Menüleiste des CMFCRibbonCategory Objekts zurück.

CMFCRibbonPanelMenuBar* GetParentMenuBar() const;

Rückgabewert

Gibt den Inhalt des m_pParentMenuBar geschützten Elements zurück.

Hinweise

CMFCRibbonCategory::GetParentRibbonBar

Ruft die übergeordnete Menübandleiste für die Menübandkategorie ab.

CMFCRibbonBar* GetParentRibbonBar() const;

Rückgabewert

Zeigen Sie auf die übergeordnete Menübandleiste für die Menübandkategorie.

Hinweise

CMFCRibbonCategory::GetRect

Ruft das Anzeigerechteck für die Menübandkategorie ab.

CRect GetRect() const;

Rückgabewert

Das Anzeigerechteck für die Menübandkategorie.

Hinweise

Das Anzeigerechteck für die Menübandkategorie enthält nicht die Registerkarte "Kategorie".

CMFCRibbonCategory::GetSmallImages

Ruft die Liste der kleinen Bilder ab, die in der Menübandkategorie enthalten sind.

CMFCToolBarImages& GetSmallImages();

Rückgabewert

Die Liste der kleinen Bilder, die in der Menübandkategorie enthalten sind.

CMFCRibbonCategory::GetTabColor

Gibt die aktuelle Farbe der Registerkarte "Kategorie" des Menübands zurück.

AFX_RibbonCategoryColor GetTabColor() const;

Rückgabewert

Die aktuelle Farbe der Registerkarte "Kategorie" des Menübands.

Hinweise

Der zurückgegebene Wert kann einer der folgenden Aufzählungswerte sein:

  • AFX_CategoryColor_Red

  • AFX_CategoryColor_Orange

  • AFX_CategoryColor_Yellow

  • AFX_CategoryColor_Green

  • AFX_CategoryColor_Blue

  • AFX_CategoryColor_Indigo

  • AFX_CategoryColor_Violet

CMFCRibbonCategory::GetTabRect

Ruft das Anzeigerechteck für die Registerkarte der Menübandkategorie ab.

CRect GetTabRect() const;

Rückgabewert

Das Anzeigerechteck für die Registerkarte "Menübandkategorie".

Hinweise

CMFCRibbonCategory::GetTextTopLine

Ruft die vertikale Position von Text auf Menübandschaltflächen in der Menübandkategorie ab, in der große Bilder angezeigt werden.

int GetTextTopLine() const;

Rückgabewert

Die vertikale Position von Text in Pixeln auf Menübandschaltflächen, die große Bilder anzeigen.

Hinweise

CMFCRibbonCategory::GetVisibleElements

Ruft alle sichtbaren Elemente ab, die zur Menübandkategorie gehören.

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

Parameter

arElements
Array aller sichtbaren Elemente.

Hinweise

CMFCRibbonCategory::HighlightPanel

Hebt den angegebenen Menübandbereich hervor.

CMFCRibbonPanel* HighlightPanel(
    CMFCRibbonPanel* pHLPanel,
    CPoint point);

Parameter

pHLPanel
[in] Zeigen Sie auf den Menübandbereich, um den Text hervorzuheben.

Punkt
[in] Die X- und Y-Koordinaten des Zeigers relativ zur oberen linken Ecke des Fensters.

Rückgabewert

Zeiger auf den zuvor hervorgehobenen Menübandbereich; andernfalls NULL, wenn kein Menübandpanel hervorgehoben wird, wenn diese Methode aufgerufen wird.

Hinweise

Weitere Informationen zum Hervorheben eines Menübandpanels finden Sie unter CMFCRibbonPanel::Highlight.

CMFCRibbonCategory::HitTest

Ruft einen Zeiger auf ein Menübandelement ab, wenn sich der angegebene Punkt darin befindet.

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

Parameter

Punkt
[in] Die x- und y-Koordinaten des Mauszeigers relativ zur oberen linken Ecke des Fensters.

bCheckPanelCaption
[in] TRUE, um die Beschriftung des Menübandbereichs zu testen; FALSE, um die Beschriftung des Menübandbereichs auszuschließen.

Rückgabewert

Zeigen Sie auf ein Menübandelement, wenn die Methode erfolgreich war; andernfalls NULL.

Hinweise

Es werden nur Menübandelemente getestet, die in der Menübandkategorie enthalten sind.

CMFCRibbonCategory::HitTestEx

Ruft den nullbasierten Index eines Menübandelements ab, wenn sich der angegebene Punkt darin befindet.

int HitTestEx(CPoint point) const;

Parameter

Punkt
[in] Die x- und y-Koordinaten des Mauszeigers relativ zur oberen linken Ecke des Fensters.

Rückgabewert

Nullbasierter Index eines Menübandelements, wenn die Methode erfolgreich war; andernfalls -1.

Hinweise

Es werden nur Menübandelemente getestet, die in der Menübandkategorie enthalten sind.

CMFCRibbonCategory::HitTestScrollButtons

Wenn ein Punkt in die Linke oder rechte Bildlaufschaltfläche einer Menübandkategorie fällt, wird ein Zeiger auf diese Schaltfläche zurückgegeben.

CMFCRibbonBaseElement* HitTestScrollButtons(CPoint point) const;

Parameter

Punkt
[in] Der zu testende Punkt.

Rückgabewert

Wenn der Punkt innerhalb des umgebenden Rechtecks der Linken oder der rechten Bildlaufschaltfläche der Menübandkategorie liegt, wird ein Zeiger auf diese Schaltfläche zurückgegeben oder andernfalls NULL zurückgegeben.

Hinweise

CMFCRibbonCategory::IsActive

Gibt an, ob die Menübandkategorie die aktive Kategorie auf der Menübandleiste ist.

BOOL IsActive() const;

Rückgabewert

TRUE, wenn die Menübandkategorie die aktive Kategorie ist; andernfalls FALSE.

Hinweise

Die aktive Menübandkategorie zeigt die zugehörigen Menübandbereiche an.

CMFCRibbonCategory::IsVisible

Gibt an, ob die Menübandkategorie sichtbar ist.

BOOL IsVisible() const;

Rückgabewert

TRUE, wenn die Menübandkategorie sichtbar ist; andernfalls FALSE.

Hinweise

Menübandkategorien, die sichtbar sind, zeigen eine Kategorieregisterkarte an.

CMFCRibbonCategory::IsWindows7Look

Gibt an, ob das übergeordnete Menüband windows 7 aussieht (kleine rechteckige Anwendungsschaltfläche).

BOOL IsWindows7Look() const;

Rückgabewert

TRUE, wenn das übergeordnete Menüband windows 7 aussieht; andernfalls FALSE.

Hinweise

CMFCRibbonCategory::NotifyControlCommand

Liefert eine WM_NOTIFY Befehlsnachricht an alle CMFCRibbonPanel Elemente in der CMFCRibbonCategory Nachricht, bis die Nachricht behandelt wird.

virtual BOOL NotifyControlCommand(
    BOOL bAccelerator,
    int nNotifyCode,
    WPARAM wParam,
    LPARAM lParam);

Parameter

bAccelerator
[in] TRUE, wenn dieser Befehl von einer Zugriffstaste oder FALSCH stammt.

nNotifyCode
[in] Der Benachrichtigungscode.

wParam
[in] Das WPARAM-Feld der Nachricht.

lParam
[in] Das LPARAM-Feld der Nachricht.

Rückgabewert

Gibt WAHR zurück, wenn die Nachricht behandelt wurde, oder FALSE, wenn dies nicht der Fall ist.

Hinweise

CMFCRibbonCategory::OnCancelMode

Ruft den CMFCRibbonPanel Abbruchmodus in allen Elementen der CMFCRibbonCategory.

virtual void OnCancelMode();

Hinweise

CMFCRibbonCategory::OnDraw

Vom Framework aufgerufen, um die Menübandkategorie zu zeichnen.

virtual void OnDraw(CDC* pDC);

Parameter

pDC
[in] Zeigen Sie auf einen Gerätekontext für die Menübandkategorie.

Hinweise

CMFCRibbonCategory::OnDrawImage

Wird vom Framework aufgerufen, um das angegebene Bild in der Menübandkategorie zu zeichnen.

virtual BOOL OnDrawImage(
    CDC* pDC,
    CRect rect,
    CMFCRibbonBaseElement* pElement,
    BOOL bIsLargeImage,
    BOOL nImageIndex,
    BOOL bCenter);

Parameter

pDC
[in] Zeigen Sie auf einen Gerätekontext für das Bild.

rect
[in] Anzeigerechteck für das Bild.

pElement
[in] Zeigen Sie auf das Menübandelement, das das Bild enthält.

bIsLargeImage
[in] TRUE, wenn das Bild die große Größe aufweist; FALSE, wenn das Bild die kleine Größe aufweist.

nImageIndex
[in] Nullbasierter Index des Bilds im Bildarray, das in der Menübandkategorie enthalten ist.

bCenter
[in] TRUE, um das Bild im Anzeigerechteck zu zentrieren; FALSE, um das Bild in der oberen linken Ecke des Anzeigerechtecks zu zeichnen.

Rückgabewert

TRUE, wenn die Methode erfolgreich war; andernfalls FALSE.

Hinweise

CMFCRibbonCategory::OnDrawMenuBorder

Wird vom Framework aufgerufen, um den Rahmen eines Popupmenüs zu zeichnen.

virtual void OnDrawMenuBorder(
    CDC* pDC,
    CMFCRibbonPanelMenuBar* pMenuBar);

Parameter

pDC
[in] Dieser Parameter wird nicht verwendet.

pMenuBar
[in] Dieser Parameter wird nicht verwendet.

Hinweise

Standardmäßig führt diese Methode nichts aus. Überschreiben Sie diese Methode, um den Rahmen eines Popupmenüs zu zeichnen.

CMFCRibbonCategory::OnKey

Wird vom Framework aufgerufen, wenn ein Benutzer eine Tastaturtaste drückt.

virtual BOOL OnKey(UINT nChar);

Parameter

nChar
Der virtuelle Schlüsselcode für die Taste, die ein Benutzer gedrückt hat.

Hinweise

CMFCRibbonCategory::OnLButtonDown

Vom Framework aufgerufen, um das Menübandelement unter dem angegebenen Punkt abzurufen, wenn der Benutzer die linke Maustaste drückt.

virtual CMFCRibbonBaseElement* OnLButtonDown(CPoint point);

Parameter

Punkt
[in] Die x- und y-Koordinaten des Mauszeigers relativ zur oberen linken Ecke des Fensters.

Rückgabewert

Zeigen Sie auf ein Menübandelement, wenn die Methode erfolgreich war; andernfalls NULL.

Hinweise

CMFCRibbonCategory::OnLButtonUp

Wird vom Framework aufgerufen, wenn der Benutzer die linke Maustaste loslässt und der Mauszeiger sich über der Menübandkategorie befindet.

virtual void OnLButtonUp(CPoint point);

Parameter

Punkt
[in] Die X- und Y-Koordinaten des Zeigers relativ zur oberen linken Ecke des Fensters.

Hinweise

CMFCRibbonCategory::OnMouseMove

Wird vom Framework aufgerufen, wenn der Zeiger auf der Menübandleiste bewegt wird, um die Anzeige der Menübandkategorie zu aktualisieren.

virtual void OnMouseMove(CPoint point);

Parameter

Punkt
[in] Die X- und Y-Koordinaten des Zeigers relativ zur oberen linken Ecke des Fensters.

Hinweise

CMFCRibbonCategory::OnRTLChanged

Wird vom Framework aufgerufen, wenn das Layout die Richtung ändert.

virtual void OnRTLChanged(BOOL bIsRTL);

Parameter

bIsRTL
[in] TRUE, wenn das Layout von rechts nach links ist; FALSE, wenn das Layout von links nach rechts ist.

Hinweise

Diese Methode passt das Layout aller Menübandbereiche und Menübandelemente an, die in der Menübandkategorie enthalten sind.

CMFCRibbonCategory::OnScrollHorz

Scrollt die Menübandkategorie in horizontaler Richtung.

virtual BOOL OnScrollHorz(
    BOOL bScrollLeft,
    int nScrollOffset = 0);

Parameter

bScrollLeft
[in] TRUE, um nach links zu scrollen; FALSE, um nach rechts zu scrollen.

nScrollOffset
[in] Der Bildlaufabstand in Pixel.

Rückgabewert

TRUE, wenn die Menübandkategorie in horizontaler Richtung verschoben wird; andernfalls FALSE.

Hinweise

CMFCRibbonCategory::OnUpdateCmdUI

Ruft die OnUpdateCmdUI Memberfunktion in den einzelnen CMFCRibbonPanel Elementen des CMFCRibbonCategory Elements auf, um die Elemente der Benutzeroberfläche zu aktivieren oder zu deaktivieren.

virtual void OnUpdateCmdUI(
    CMFCRibbonCmdUI* pCmdUI,
    CFrameWnd* pTarget,
    BOOL bDisableIfNoHndler);

Parameter

pCmdUI
[in] Zeigen Sie auf das CMFCRibbonCmdUI Objekt, das angibt, welche Benutzeroberflächenelemente aktiviert werden sollen und welche deaktiviert werden sollen.

pTarget
[in] Zeigen Sie auf das Fenster, das die Aktivierung oder Deaktivierung der Benutzeroberflächenelemente steuert.

bDisableIfNoHndler
[in] TRUE zum Deaktivieren des Benutzeroberflächenelements, wenn kein Handler in einer Nachrichtenzuordnung definiert ist; andernfalls FALSE.

Hinweise

CMFCRibbonCategory::RecalcLayout

Passt das Layout aller Steuerelemente in der Menübandkategorie an.

virtual void RecalcLayout(CDC* pDC);

Parameter

pDC
[in] Zeigen Sie auf einen Gerätekontext für die Menübandkategorie.

Hinweise

CMFCRibbonCategory::RemovePanel

Entfernt einen Menübandbereich aus der Menübandkategorie.

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

Parameter

nIndex
[in] Die Indexnummer des zu entfernenden Bereichs. Abgerufen durch Aufrufen der CMFCRibbonCategory::GetPanelIndex-Methode .

bDelete
[in] TRUE, um das Panelobjekt aus dem Speicher zu löschen; FALSE, um das Panelobjekt zu entfernen, ohne es zu löschen.

Rückgabewert

TRUE, wenn die Methode erfolgreich war; andernfalls FALSE.

CMFCRibbonCategory::ReposPanels

Passt das Layout aller Steuerelemente in den Menübandbereichen an, die in der Menübandkategorie enthalten sind.

virtual void ReposPanels(CDC* pDC);

Parameter

pDC
[in] Zeigen Sie auf einen Gerätekontext für die Menübandbereiche, die in der Menübandkategorie enthalten sind.

Hinweise

CMFCRibbonCategory::SetCollapseOrder

Definiert die Reihenfolge, in der die Menübandbereiche der Menübandkategorie reduziert werden.

void SetCollapseOrder(const CArray<int,int>& arCollapseOrder);

Parameter

arCollapseOrder
[in] Gibt die Reduzierenreihenfolge an. Das Array enthält nullbasierte Indizes von Menübandbereichen.

Hinweise

Die Bibliothek definiert die Reduziertreihenfolge. Sie können dieses Verhalten jedoch anpassen, indem Sie die Kategorie mit der Liste der Indizes angeben, die die Reduzierenreihenfolge angibt.

Wenn die Kategorie erkennt, dass ein Menübandbereich reduziert werden muss, wird nach dem nächsten Element in der angegebenen Liste gesucht. Wenn die Liste leer ist oder Sie nicht genügend Elemente angegeben haben, verwendet die Kategorie den internen Algorithmus.

Beispielsweise verfügt die Kategorie über drei Menübandbereiche und kann mehrmals reduziert werden, bis sich alle Panels im vollständig reduzierten Zustand befinden. Sie können die folgende Reduzierenreihenfolge festlegen: 0, 0, 2, 2. In diesem Fall reduziert die Kategorie das Panel 0 zweimal, das Panel 2 zweimal. Das Panel mit dem Index von 1 bleibt nicht erfasst.

Beispiel

Im folgenden Beispiel wird die Verwendung der SetCollapseOrder Methode in der CMFCRibbonCategory Klasse veranschaulicht. Das Beispiel zeigt, wie Sie ein Array für die Reduzierenreihenfolge erstellen und wie die Reduziertreihenfolge auf die Menübandkategorie festgelegt wird.

CArray<int, int> arCollapseOrder;
arCollapseOrder.Add(0);
arCollapseOrder.Add(1);
arCollapseOrder.Add(2);
// CMFCRibbonCategory* pCategoryHome
pCategoryHome->SetCollapseOrder(arCollapseOrder);

CMFCRibbonCategory::SetData

Legt die benutzerdefinierten Daten fest, die der Menübandkategorie zugeordnet werden sollen.

void SetData(DWORD_PTR dwData);

Parameter

dwData
[in] Die benutzerdefinierten Daten.

CMFCRibbonCategory::SetKeys

Weist der Menübandkategorie eine Zugriffstasteninfo zu.

void SetKeys(LPCTSTR lpszKeys);

Parameter

lpszKeys
[in] Der QuickInfo-Text.

Hinweise

Zugriffstasteninfos werden angezeigt, wenn der Benutzer die ALT- oder F10-TASTE drückt.

CMFCRibbonCategory::SetName

Weist der Menübandkategorie einen Namen und eine Zugriffstaste zu.

void SetName(LPCTSTR lpszName);

Parameter

lpszName
[in] Der Name und die Zugriffstaste der Menübandkategorie.

Hinweise

Um die Zugriffstasteninfo für die Menübandkategorie festzulegen, fügen Sie eine Neueline-Escapesequenz gefolgt von den Zugriffstasteninfozeichen an lpszName an.

CMFCRibbonCategory::SetTabColor

Legt die Farbe der Menübandkategorie fest.

void SetTabColor(AFX_RibbonCategoryColor color);

Parameter

color
[in] Gibt die neue Farbe der Menübandkategorie an.

Hinweise

Die Farbe kann einen der folgenden Werte aufweisen:

  • AFX_CategoryColor_None

  • AFX_CategoryColor_Red

  • AFX_CategoryColor_Orange

  • AFX_CategoryColor_Yellow

  • AFX_CategoryColor_Green

  • AFX_CategoryColor_Blue

  • AFX_CategoryColor_Indigo

  • AFX_CategoryColor_Violet

Siehe auch

Hierarchiediagramm
Klassen
CObject-Klasse