CMFCRibbonBaseElement-Klasse

Artikel
10/12/2023

Die CMFCRibbonBaseElement Klasse ist die Basisklasse für alle Elemente, die Sie einer Menübandleiste hinzufügen können. Beispiele für Menübandelemente sind Menübandschaltflächen, Menübandkontrollkästchen und Menübandkombinationsfelder.

Syntax

class CMFCRibbonBaseElement : public CObject

Member

Öffentliche Konstruktoren

Name	Beschreibung
`CMFCRibbonBaseElement`	Erstellt ein `CMFCRibbonBaseElement`-Objekt.

Öffentliche Methoden

Name	Beschreibung
CMFCRibbonBaseElement::AddToKeyList	Fügt einem Array von Zugriffstasteninfos eine Zugriffstasteninfo für das Menübandelement hinzu.
CMFCRibbonBaseElement::AddToListBox	Fügt dem angegebenen Menübandbefehlslistenfeld ein Menübandelement hinzu.
CMFCRibbonBaseElement::CanBeAddedToQuickAccessToolBar	Gibt an, ob das Menübandelement der Symbolleiste für den Schnellzugriff hinzugefügt werden kann.
CMFCRibbonBaseElement::CanBeCompacted	Gibt an, ob die Größe des Menübandelements kompakt sein kann.
CMFCRibbonBaseElement::CanBeStretched	Gibt an, ob die Höhe des Menübandelements vertikal auf die Höhe einer Menübandzeile erhöht werden kann.
CMFCRibbonBaseElement::CanBeStretchedHorizontally	Gibt an, ob sich die Breite des Menübandelements ändern kann.
CMFCRibbonBaseElement::CleanUpSizes	Bereinigt die Bemaßungseinstellungen für das Menübandelement.
CMFCRibbonBaseElement::ClosePopupMenu	Schließt das Popupmenü für das Menübandelement.
CMFCRibbonBaseElement::CopyFrom	Kopiert den Zustand des angegebenen `CMFCRibbonBaseElement` Objekts an das aktuelle Objekt.
CMFCRibbonBaseElement::D estroyCtrl	Zerstört das Menübandelement.
CMFCRibbonBaseElement::D rawImage	Zeichnet das Bild für das Menübandelement.
CMFCRibbonBaseElement::Find	Gibt den angegebenen Zeiger auf das Menübandelement zurück, wenn er auf das aktuelle Objekt zeigt.
CMFCRibbonBaseElement::FindByData	Ruft einen Zeiger auf das Menübandelement ab, wenn er die angegebenen Daten enthält.
CMFCRibbonBaseElement::FindByID	Ruft einen Zeiger auf das Menübandelement ab, wenn dieses Element durch die angegebene Befehls-ID identifiziert wird.
CMFCRibbonBaseElement::FindByOriginal	Ruft einen Zeiger auf das Menübandelement ab, wenn das ursprüngliche Menübandelement dem angegebenen Menübandelement entspricht.
CMFCRibbonBaseElement::GetCompactSize	Gibt die komprimierte Größe des Menübandelements zurück.
CMFCRibbonBaseElement::GetData	Ruft die benutzerdefinierten Daten ab, die dem Menübandelement zugeordnet sind.
CMFCRibbonBaseElement::GetDescription	Gibt die Beschreibung des Menübandelements zurück.
CMFCRibbonBaseElement::GetDroppedDown	Ruft einen Zeiger auf das Menübandelement ab, wenn das Popupmenü gelöscht wird.
CMFCRibbonBaseElement::GetElements	Fügt das aktuelle Menübandelement zum angegebenen Array hinzu.
CMFCRibbonBaseElement::GetElementsByID	Fügt das aktuelle Menübandelement dem angegebenen Array hinzu, wenn das aktuelle Menübandelement die angegebene Befehls-ID enthält.
CMFCRibbonBaseElement::GetHighlighted	Ruft einen Zeiger auf das Menübandelement ab, wenn es hervorgehoben ist.
CMFCRibbonBaseElement::GetID	Gibt die Befehls-ID des Menübandelements zurück.
CMFCRibbonBaseElement::GetImageSize	Gibt die Bildgröße des Menübandelements zurück.
CMFCRibbonBaseElement::GetIntermediateSize	Gibt die Größe des Menübandelements im Zwischenstatus zurück.
CMFCRibbonBaseElement::GetKeys	Gibt die dem Menübandelement zugeordnete Zugriffstasteninfo zurück.
CMFCRibbonBaseElement::GetKeyTipRect	Ruft das Rechteck für die Zugriffstasteninfo für das Menübandelement ab.
CMFCRibbonBaseElement::GetKeyTipSize	Ruft die Größe des Zugriffstasteninfotexts ab.
CMFCRibbonBaseElement::GetLocationInGroup	Gibt die Anzeigeposition des Menübandelements in einer Menübandgruppe an.
CMFCRibbonBaseElement::GetMenuKeys	Gibt die Mit einer Schaltfläche verknüpften Zugriffstasteninfos zurück.
CMFCRibbonBaseElement::GetNotifyID	Ruft die Benachrichtigungsbefehls-ID für das Menübandelement ab.
CMFCRibbonBaseElement::GetOriginal	Ruft das ursprüngliche Menübandelement ab.
CMFCRibbonBaseElement::GetParentCategory	Ruft die Menübandkategorie für das Menübandelement ab.
CMFCRibbonBaseElement::GetParentPanel	Ruft den Menübandbereich ab, der das Menübandelement enthält.
CMFCRibbonBaseElement::GetParentRibbonBar	Ruft die übergeordnete Menübandleiste für das Menübandelement ab.
CMFCRibbonBaseElement::GetParentWnd	Ruft das übergeordnete Fenster für das Menübandelement ab.
CMFCRibbonBaseElement::GetPressed	Ruft einen Zeiger auf das Menübandelement ab, wenn der Benutzer ihn gerade drückt.
CMFCRibbonBaseElement::GetQuickAccessToolBarID	Ruft die Befehls-ID des Menübandelements ab, wenn es sich in der Symbolleiste für den Schnellzugriff befindet.
CMFCRibbonBaseElement::GetRect	Gibt das umgebende Rechteck des Menübandelements zurück.
CMFCRibbonBaseElement::GetRegularSize	Gibt die reguläre Größe des Menübandelements zurück.
CMFCRibbonBaseElement::GetSize	Gibt die aktuelle Größe des Menübandelements zurück.
CMFCRibbonBaseElement::GetText	Gibt den Text zurück, der dem Menübandelement zugeordnet ist.
CMFCRibbonBaseElement::GetToolTipText	Gibt den QuickInfo-Text des Menübandelements zurück.
CMFCRibbonBaseElement::GetTopLevelRibbonBar	Ruft die Menübandleiste der obersten Ebene für das Menübandelement ab.
CMFCRibbonBaseElement::HasCompactMode	Gibt an, ob das Menübandelement über einen Komprimierungsmodus verfügt.
CMFCRibbonBaseElement::HasFocus	Gibt an, ob das übergeordnete Element den Tastaturfokus hat.
CMFCRibbonBaseElement::HasIntermediateMode	Gibt an, ob das Menübandelement über einen Zwischenstatus verfügt
CMFCRibbonBaseElement::HasLargeMode	Gibt an, ob das Menübandelement über einen großen Modus verfügt.
CMFCRibbonBaseElement::HasMenu	Gibt an, ob das Menübandelement über ein Menü verfügt.
CMFCRibbonBaseElement::HitTest	Ruft einen Zeiger auf das Menübandelement ab, wenn sich der angegebene Punkt darin befindet.
CMFCRibbonBaseElement::IsAlignByColumn	Gibt an, ob das Menübandelement vertikal an anderen Menübandelementen ausgerichtet ist.
CMFCRibbonBaseElement::IsAlwaysLargeImage	Gibt an, ob die Bildgröße des Menübandelements immer groß ist.
CMFCRibbonBaseElement::IsAutoRepeatMode	Gibt an, ob sich das Menübandelement im automatischen Wiederholungsmodus befindet.
CMFCRibbonBaseElement::IsChecked	Gibt an, ob das Menübandelement aktiviert ist.
CMFCRibbonBaseElement::IsCompactMode	Gibt an, ob sich das Menübandelement in einem kompakten Modus befindet.
CMFCRibbonBaseElement::IsDefaultMenuLook
CMFCRibbonBaseElement::IsDisabled	Gibt an, ob das Menübandelement deaktiviert ist.
CMFCRibbonBaseElement::IsDroppedDown	Bestimmt, ob das Menübandelement ein Popupmenü anzeigt und nach unten abgelegt wird.
CMFCRibbonBaseElement::IsFocused	Gibt an, ob das Menübandelement den Fokus hat.
CMFCRibbonBaseElement::IsGalleryIcon	Gibt an, ob das Menübandelement in einem Menübandkatalog enthalten ist.
CMFCRibbonBaseElement::IsHighlighted	Gibt an, ob das Menübandelement hervorgehoben ist.
CMFCRibbonBaseElement::IsIntermediateMode	Gibt an, ob das aktuelle Bild für das Menübandelement Zwischengröße ist.
CMFCRibbonBaseElement::IsLargeMode	Gibt an, ob das aktuelle Bild für das Menübandelement groß ist.
CMFCRibbonBaseElement::IsMenuMode	Gibt an, ob das Menübandelement in einem Menü enthalten ist.
CMFCRibbonBaseElement::IsPressed	Gibt an, ob der Benutzer auf das Menübandelement geklickt hat.
CMFCRibbonBaseElement::IsQATMode	Gibt an, ob das Menübandelement in der Symbolleiste für den Schnellzugriff enthalten ist.
CMFCRibbonBaseElement::IsSeparator	Gibt an, ob das Menübandelement ein Anzeigetrennzeichen ist.
CMFCRibbonBaseElement::IsShowGroupBorder	Gibt an, ob das Menübandelement in einer Gruppe enthalten ist, die einen gemeinsamen Rahmen anzeigt.
CMFCRibbonBaseElement::IsShowTooltipOnBottom	Gibt an, ob die QuickInfo unter dem Menübandelement angezeigt wird.
CMFCRibbonBaseElement::IsTabStop	Gibt an, ob das Menübandelement mit der Tastatur ausgewählt werden kann.
CMFCRibbonBaseElement::IsTextAlwaysOnRight	Gibt an, ob der Text für das Menübandelement rechts angezeigt wird.
CMFCRibbonBaseElement::IsVisible	Gibt an, ob das Menübandelement derzeit angezeigt wird.
CMFCRibbonBaseElement::IsWholeRowHeight	Gibt an, ob der Anzeigehen des Menübandelements mit der Anzeigehöhe des Menübandpanels identisch ist, das es enthält.
CMFCRibbonBaseElement::NotifyCommand	Sendet eine Befehlsbenachrichtigung an das übergeordnete Fenster des Menübandelements.
CMFCRibbonBaseElement::NotifyHighlightListItem	Benachrichtigt das übergeordnete Fenster der Menübandleiste, wenn ein Benutzer ein Menübandelement hervorhebung, das sich in einer Liste befindet.
CMFCRibbonBaseElement::OnAddToQAToolbar	Fügt das Menübandelement zur angegebenen Symbolleiste für den Schnellzugriff hinzu.
CMFCRibbonBaseElement::OnAfterChangeRect	Aktualisiert die QuickInfo für das Menübandelement.
CMFCRibbonBaseElement::OnAutoRepeat	Aktualisiert das Menübandelement als Reaktion auf dauerhafte Benutzereingaben.
CMFCRibbonBaseElement::OnCalcTextSize	Berechnet die Größe des Texts für das Menübandelement.
CMFCRibbonBaseElement::OnChangeMenuHighlight	Wird vom Framework aufgerufen, wenn sich die Hervorhebung für ein Menübandelement ändert, das sich in einem Menü befindet.
CMFCRibbonBaseElement::OnDraw	Wird vom Framework aufgerufen, um das Menübandelement zu zeichnen.
CMFCRibbonBaseElement::OnDrawKeyTip	Vom Framework aufgerufen, um die Zugriffstasteninfo für das Menübandelement zu zeichnen.
CMFCRibbonBaseElement::OnDrawMenuImage	Wird vom Framework aufgerufen, wenn das Menübild für das Menübandelement gezeichnet wird.
CMFCRibbonBaseElement::OnDrawOnList	Wird vom Framework aufgerufen, um das Menübandelement in einem Befehlslistenfeld zu zeichnen.
CMFCRibbonBaseElement::OnKey	Wird vom Framework aufgerufen, wenn der Benutzer eine Zugriffstasteninfo drückt und das Menübandelement den Fokus hat.
CMFCRibbonBaseElement::OnMenuKey
CMFCRibbonBaseElement::OnRTLChanged	Wird vom Framework aufgerufen, wenn das Layout die Richtung ändert.
CMFCRibbonBaseElement::OnShow	Wird vom Framework aufgerufen, um das Menübandelement ein- oder auszublenden.
CMFCRibbonBaseElement::OnShowPopupMenu	Wird vom Framework aufgerufen, wenn das Menübandelement ein Popupmenü anzeigt.
CMFCRibbonBaseElement::P ostMenuCommand
CMFCRibbonBaseElement::Redraw	Aktualisiert die Anzeige für das Menübandelement.
CMFCRibbonBaseElement::SetACCData	Legt die Barrierefreiheitsdaten für das Menübandelement fest.
CMFCRibbonBaseElement::SetCompactMode	Legt die Anzeigegröße für das Menübandelement fest.
CMFCRibbonBaseElement::SetData	Ordnet ein Datenelement dem Menübandelement zu.
CMFCRibbonBaseElement::SetDefaultMenuLook
CMFCRibbonBaseElement::SetDescription	Legt die Beschreibung für das Menübandelement fest.
CMFCRibbonBaseElement::SetID	Legt die Befehls-ID des Menübandelements fest.
CMFCRibbonBaseElement::SetInitialMode	Legt die anfängliche Anzeigegröße für das Menübandelement fest.
CMFCRibbonBaseElement::SetKeys	Legt eine Zugriffstasteninfo für das Menübandelement fest.
CMFCRibbonBaseElement::SetOriginal	Legt das ursprüngliche Menübandelement für das Menübandelement fest.
CMFCRibbonBaseElement::SetParentCategory	Legt die übergeordnete Kategorie für das Menübandelement fest.
CMFCRibbonBaseElement::SetParentMenu	Legt den übergeordneten Menücontainer für das Menübandelement fest.
CMFCRibbonBaseElement::SetParentRibbonBar	Legt die übergeordnete Menübandleiste für das Menübandelement fest.
CMFCRibbonBaseElement::SetRect	Legt die Abmessungen fest, für die das Menübandelement rechteck angezeigt wird.
CMFCRibbonBaseElement::SetText	Legt den Text für das Menübandelement fest.
CMFCRibbonBaseElement::SetTextAlwaysOnRight	Legt den Text für das Menübandelement fest, das auf der rechten Seite angezeigt werden soll.
CMFCRibbonBaseElement::SetToolTipText	Legt den QuickInfo-Text für das Menübandelement fest.
CMFCRibbonBaseElement::SetVisible	Legt den Sichtbarkeitsstatus des Menübandelements fest.
CMFCRibbonBaseElement::StretchHorizontally	Streckt die Breite des Menübandelements.
CMFCRibbonBaseElement::StretchToWholeRow	Ändert die Anzeigehöhe des Menübandelements in die angegebene Zeilenhöhe.
CMFCRibbonBaseElement::UpdateTooltipInfo	Aktualisiert den QuickInfo-Text mithilfe der Befehlsressource für das Menübandelement.

Geschützte Methoden

Name	Beschreibung
CMFCRibbonBaseElement::OnProcessKey	Wird vom Framework aufgerufen, wenn der Benutzer eine Tastenkombination drückt.
CMFCRibbonBaseElement::OnSetFocus	Wird vom Framework aufgerufen, wenn ein Menübandelement den Eingabefokus empfängt oder verliert.

Hinweise

Die CMFCRibbonBaseElement Klasse definiert die Eigenschaften, die allen Menübandelementen gemeinsam sind, die Befehls-ID, Textbeschriftung, QuickInfo-Text, Elementbeschreibung und Status enthalten (die fokussiert, hervorgehoben, gedrückt, deaktiviert, aktiviert oder gelöscht werden können).

Die Bildgröße eines Menübandelements wird durch das RibbonImageType Element definiert, bei dem es sich um einen der folgenden Werte handeln kann:

RibbonImageLarge
RibbonImageSmall

Je nach Größe zeigt ein Menübandelement entweder ein kleines oder großes Bild an.

Beispiel

Das folgende Beispiel veranschaulicht die Verwendung verschiedener Methoden in der CMFCRibbonBaseElement -Klasse. Das Beispiel zeigt, wie Sie ein CMFCRibbonBaseElement Objekt aus einer CMFCRibbonStatusBar Klasse abrufen, die Beschreibung für das Menübandelement festlegen, den Text festlegen, eine Zugriffstasteninfo festlegen und den QuickInfo-Text für das Menübandelement festlegen. Dieser Codeausschnitt ist Teil des Draw Client-Beispiels.

// CMFCRibbonStatusBar m_wndStatusBar
CMFCRibbonBaseElement *pPane = m_wndStatusBar.FindByID(nID);

pPane->SetDescription(_T("a pane"));
// CString strText
pPane->SetText(strText);
pPane->SetKeys(_T("p"));
pPane->SetToolTipText(_T("this is a pane"));

Vererbungshierarchie

CObject

CMFCRibbonBaseElement

Anforderungen

Header: afxbaseribbonelement.h

CMFCRibbonBaseElement::AddToKeyList

Fügt einem Array von Zugriffstasteninfos eine Zugriffstasteninfo für das Menübandelement hinzu.

virtual void AddToKeyList(
    CArray<CMFCRibbonKeyTip*, CMFCRibbonKeyTip*>& arElems);

Parameter

arElems
[in] Verweis auf ein CArray von Zugriffstasteninfos.

Hinweise

Wenn das Feature für Menübandtasteninfos aktiviert ist, zeigt das Framework Menübandtasteninfos an, wenn der Benutzer die ALT-TASTE oder F10-TASTE drückt.

CMFCRibbonBaseElement::AddToListBox

Fügt dem angegebenen Menübandbefehlslistenfeld ein Menübandelement hinzu.

virtual int AddToListBox(
    CMFCRibbonCommandsListBox* pWndListBox,
    BOOL bDeep);

Parameter

pWndListBox
[in] Zeigen Sie auf ein Befehlslistenfeld.

bDeep
[in] Dieser Parameter wird nicht verwendet.

Rückgabewert

Der nullbasierte Index des hinzugefügten Menübandelements.

Hinweise

Das Framework fügt menübandelemente zu einem Befehlslistenfeld hinzu, damit der Benutzer die Benutzeroberfläche anpassen kann.

CMFCRibbonBaseElement::CanBeAddedToQuickAccessToolBar

Gibt an, ob das Menübandelement der Symbolleiste für den Schnellzugriff hinzugefügt werden kann.

virtual BOOL CanBeAddedToQuickAccessToolBar() const;

Rückgabewert

TRUE, wenn das Element hinzugefügt werden kann; andernfalls FALSE.

Hinweise

CMFCRibbonBaseElement::CanBeCompacted

Gibt an, ob die Größe des Menübandelements kompakt sein kann.

virtual BOOL CanBeCompacted() const;

Rückgabewert

TRUE, wenn die Größe des Menübandelements kompakt sein kann; andernfalls FALSE.

Hinweise

Die Größe eines Menübandelements kann kompakt, zwischen oder groß sein.

CMFCRibbonBaseElement::CanBeStretched

Gibt an, ob die Höhe des Menübandelements vertikal auf die Höhe einer Menübandzeile erhöht werden kann.

virtual BOOL CanBeStretched();

Rückgabewert

Gibt immer TRUE zurück.

Hinweise

Standardmäßig gibt diese Methode immer TRUE zurück. Überschreiben Sie diese Methode, um anzugeben, ob die Höhe des Menübandelements vertikal auf die Höhe einer Menübandzeile erhöht werden kann.

CMFCRibbonBaseElement::CanBeStretchedHorizontally

Gibt an, ob sich die Breite des Menübandelements ändern kann.

virtual BOOL CanBeStretchedHorizontally();

Rückgabewert

Gibt immer FALSE zurück.

Hinweise

Standardmäßig gibt diese Methode immer FALSE zurück. Überschreiben Sie diese Methode, um anzugeben, ob sich die Breite des Menübandelements ändern kann.

CMFCRibbonBaseElement::CleanUpSizes

Bereinigt die Bemaßungseinstellungen für das Menübandelement.

virtual void CleanUpSizes();

Hinweise

Standardmäßig führt diese Methode nichts aus. Überschreiben Sie diese Methode in einer abgeleiteten Klasse, um die Bemaßungseinstellungen für das Menübandelement zurückzusetzen.

CMFCRibbonBaseElement::ClosePopupMenu

Schließt das Popupmenü für das Menübandelement.

virtual void ClosePopupMenu();

Hinweise

CMFCRibbonBaseElement::CopyFrom

Kopiert den Status des angegebenen CMFCRibbonBaseElements in das aktuelle Objekt.

virtual void CopyFrom(const CMFCRibbonBaseElement& src);

Parameter

src
[in] Das Quellobjekt CMFCRibbonBaseElement .

Hinweise

CMFCRibbonBaseElement::D estroyCtrl

Zerstört das Menübandelement.

virtual void DestroyCtrl();

Hinweise

Standardmäßig führt diese Methode nichts aus. Überschreiben Sie diese Methode in einer abgeleiteten Klasse, um das Menübandelement zu zerstören.

CMFCRibbonBaseElement::D rawImage

Zeichnet das Bild für das Menübandelement.

virtual void DrawImage(
    CDC* pDC,
    RibbonImageType type,
    CRect rectImage);

Parameter

pDC
[in] Zeiger auf einen Gerätekontext.

type
[in] Ein aufgezählter Bildtypwert. Eine Liste möglicher Werte finden Sie im Abschnitt "Hinweise".

rectImage
[in] Das Bildrechteck.

Hinweise

Standardmäßig führt diese Methode nichts aus. Überschreiben Sie diese Methode in einer abgeleiteten Klasse, um das Bild für das Menübandelement zu zeichnen.

In der folgenden Tabelle sind mögliche Werte für den Typparameter aufgeführt:

Wert	Beschreibung
`RibbonImageLarge`	Große Bildgröße von 32 x 32 Pixel.
`RibbonImageSmall`	Kleine Bildgröße von 16 x 16 Pixeln.

CMFCRibbonBaseElement::Find

Gibt den angegebenen Zeiger zurück, wenn er auf das aktuelle Objekt zeigt.

virtual CMFCRibbonBaseElement* Find(const CMFCRibbonBaseElement* pElement);

Parameter

pElement
[in] Zeiger auf ein Menübandelement.

Rückgabewert

Ein Zeiger auf das Menübandelement, wenn pElement auf das aktuelle Objekt zeigt; andernfalls NULL.

Hinweise

CMFCRibbonBaseElement::FindByData

Ruft einen Zeiger auf das Menübandelement ab, wenn er die angegebenen Daten enthält.

virtual CMFCRibbonBaseElement* FindByData(DWORD_PTR dwData);

Parameter

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

Rückgabewert

Ein Zeiger auf das Menübandelement, wenn er die angegebenen Daten enthält; andernfalls NULL.

Hinweise

CMFCRibbonBaseElement::FindByID

Ruft einen Zeiger auf das Menübandelement ab, wenn dieses Element durch die angegebene Befehls-ID identifiziert wird.

virtual CMFCRibbonBaseElement* FindByID(UINT uiCmdID);

Parameter

uiCmdID
[in] Befehls-ID für ein Menübandelement.

Rückgabewert

Ein Zeiger auf das Menübandelement, wenn dieses Element durch die angegebene Befehls-ID identifiziert wird; andernfalls NULL.

Hinweise

CMFCRibbonBaseElement::FindByOriginal

Ruft einen Zeiger auf das aktuelle Menübandelement ab, wenn das ursprüngliche Menübandelement dem angegebenen Menübandelement entspricht.

virtual CMFCRibbonBaseElement* FindByOriginal(CMFCRibbonBaseElement* pOriginal);

Parameter

pOriginal
[in] Zeiger auf ein Menübandelement.

Rückgabewert

Ein Zeiger auf das Menübandelement, wenn das ursprüngliche Menübandelement dem angegebenen Menübandelement entspricht; andernfalls NULL.

Hinweise

Menübandelemente, die in einen anderen Container kopiert werden, behalten einen Zeiger auf das ursprüngliche Menübandelement bei.

CMFCRibbonBaseElement::GetCompactSize

Gibt die komprimierte Größe des Menübandelements zurück.

virtual CSize GetCompactSize(CDC* pDC);

Parameter

pDC
[in] Ein Zeiger auf einen Gerätekontext.

Rückgabewert

Die kompakte Größe eines Menübandelements.

Hinweis

Die kompakte Größe bedeutet, dass das Menübandelement abgeschnitten wird (es zeigt ein kleines Bild oder ein Bild ohne Text an).

CMFCRibbonBaseElement::GetData

Ruft die benutzerdefinierten Daten ab, die dem Menübandelement zugeordnet sind.

DWORD_PTR GetData() const;

Rückgabewert

Die benutzerdefinierten Daten, die dem Menübandelement zugeordnet sind.

CMFCRibbonBaseElement::GetDescription

Gibt die Beschreibung des Menübandelements zurück.

virtual CString GetDescription() const;

Rückgabewert

Beschreibung des Menübandelements. Die Beschreibung wird entweder auf der Statusleiste oder in einer QuickInfo oder unter der Menüschaltfläche angezeigt, wenn sich das Menübandelement in der CMFCRibbonMainPanel-Klasse befindet.

CMFCRibbonBaseElement::GetDroppedDown

Ruft einen Zeiger auf das Menübandelement ab, wenn das Popupmenü gelöscht wird.

virtual CMFCRibbonBaseElement* GetDroppedDown();

Rückgabewert

Ein Zeiger auf das Menübandelement, wenn das Popupmenü nach unten abgelegt wird. andernfalls NULL.

Hinweise

CMFCRibbonBaseElement::GetElements

Fügt das aktuelle Menübandelement zum angegebenen Array hinzu.

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

Parameter

arElements
[in, out] Ein Array von Menübandelementen.

Hinweise

CMFCRibbonBaseElement::GetElementsByID

Fügt das aktuelle Menübandelement dem angegebenen Array hinzu, wenn das aktuelle Menübandelement die angegebene Befehls-ID enthält.

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

Parameter

uiCmdID
[in] Befehls-ID eines Menübandelements.

arElements
[in] Ein Array von Menübandelementen.

Hinweise

CMFCRibbonBaseElement::GetHighlighted

Ruft einen Zeiger auf das Menübandelement ab, wenn es hervorgehoben ist.

virtual CMFCRibbonBaseElement* GetHighlighted();

Rückgabewert

Ein Zeiger auf das Menübandelement, wenn es hervorgehoben ist; andernfalls NULL.

Hinweise

CMFCRibbonBaseElement::GetID

Gibt die Befehls-ID des Menübandelements zurück.

UINT GetID() const;

Rückgabewert

Die Befehls-ID des Menübandelements.

CMFCRibbonBaseElement::GetImageSize

Gibt die Bildgröße des Menübandelements zurück.

virtual CSize GetImageSize(RibbonImageType R) const;

Rückgabewert

Die Bildgröße des Menübandelements.

CMFCRibbonBaseElement::GetIntermediateSize

Gibt die Größe des Menübandelements im Zwischenstatus zurück.

virtual CSize GetIntermediateSize(CDC* pDC);

Parameter

pDC
[in] Ein Zeiger auf einen Gerätekontext.

Rückgabewert

Die Größe des Menübandelements im Zwischenzustand.

CMFCRibbonBaseElement::GetKeys

Gibt die dem Menübandelement zugeordnete Zugriffstasteninfo zurück.

LPCTSTR GetKeys() const;

Rückgabewert

Eine Zugriffstasteninfo, die dem Menübandelement zugeordnet ist.

CMFCRibbonBaseElement::GetKeyTipRect

Ruft das Rechteck für die Zugriffstasteninfo für das Menübandelement ab.

virtual CRect GetKeyTipRect(
    CDC* pDC,
    BOOL bIsMenu);

Parameter

pDC
[in] Zeiger auf einen Gerätekontext.

bIsMenu
[in] TRUE, wenn das Menübandelement ein Popupmenü anzeigt; andernfalls FALSE.

Rückgabewert

Gibt immer ein Rechteck mit 0 Werten zurück.

Hinweise

Überschreiben Sie diese Methode in einer abgeleiteten Klasse, um das Rechteck für die Zugriffstastenbegrenzung zurückzugeben.

CMFCRibbonBaseElement::GetKeyTipSize

Ruft die Größe des Zugriffstasteninfotexts ab.

virtual CSize GetKeyTipSize(CDC* pDC);

Parameter

pDC
[in] Zeiger auf einen Gerätekontext.

Rückgabewert

Die Größe des Zugriffstasteninfotexts.

Hinweise

CMFCRibbonBaseElement::GetLocationInGroup

Gibt die Anzeigeposition des Menübandelements in einer Menübandgruppe an.

RibbonElementLocation GetLocationInGroup() const;

Rückgabewert

Ein RibbonElementLocation aufgezählter Wert. In der folgenden Tabelle sind die möglichen Werte aufgelistet.

Wert	Beschreibung
`RibbonElementNotInGroup`	Das Menübandelement ist nicht in einer Menübandgruppe enthalten.
`RibbonElementSingleInGroup`	Das Menübandelement wird als einziges Element in einer Menübandgruppe angezeigt.
`RibbonElementFirstInGroup`	Das Menübandelement wird am linken Ende einer Menübandgruppe angezeigt.
`RibbonElementLastInGroup`	Das Menübandelement wird am rechten Ende einer Menübandgruppe angezeigt.
`RibbonElementMiddleInGroup`	Das Menübandelement wird nicht am Ende einer Menübandgruppe angezeigt.

Hinweise

Menübandelementgruppen werden nur horizontal ausgerichtet.

CMFCRibbonBaseElement::GetMenuKeys

Gibt die Menütasteninfo für das Menübandelement zurück.

LPCTSTR GetMenuKeys() const;

Rückgabewert

Die Menütasteninfo, die dem Menübandelement zugeordnet ist.

Hinweise

Wenn eine Menütasteninfo aufgerufen wird, wird ein Popupmenü angezeigt.

CMFCRibbonBaseElement::GetNotifyID

Ruft die Benachrichtigungsbefehls-ID für das Menübandelement ab.

virtual UINT GetNotifyID();

Rückgabewert

Die Benachrichtigungsbefehls-ID.

Hinweise

CMFCRibbonBaseElement::GetOriginal

Ruft das ursprüngliche Menübandelement ab.

CMFCRibbonBaseElement* GetOriginal() const;

Rückgabewert

Ein Zeiger auf das ursprüngliche Menübandelement.

Hinweise

Menübandelemente, die in einen anderen Container kopiert werden, behalten einen Zeiger auf das ursprüngliche Menübandelement bei.

CMFCRibbonBaseElement::GetParentCategory

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

CMFCRibbonCategory* GetParentCategory() const;

Rückgabewert

Ein Zeiger auf die Menübandkategorie.

Hinweise

CMFCRibbonBaseElement::GetParentPanel

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

virtual CMFCRibbonPanel* GetParentPanel() const;

Rückgabewert

Ein Zeiger auf den Menübandbereich, der das Menübandelement enthält.

Hinweise

CMFCRibbonBaseElement::GetParentRibbonBar

Ruft die übergeordnete Menübandleiste für das Menübandelement ab.

CMFCRibbonBar* GetParentRibbonBar() const;

Rückgabewert

Ein Zeiger auf die übergeordnete Menübandleiste für das Menübandelement.

Hinweise

CMFCRibbonBaseElement::GetParentWnd

Ruft das übergeordnete Fenster für das Menübandelement ab.

virtual CWnd* GetParentWnd() const;

Rückgabewert

Ein Zeiger auf das übergeordnete Fenster für das Menübandelement, wenn die Methode erfolgreich war; andernfalls NULL.

Hinweise

Das übergeordnete Fenster für ein Menübandelement ist eine CMFCRibbonBar-Klasse oder eine CMFCRibbonPanelMenuBar.

CMFCRibbonBaseElement::GetPressed

Ruft einen Zeiger auf das Menübandelement ab, wenn der Benutzer ihn gerade drückt.

virtual CMFCRibbonBaseElement* GetPressed();

Rückgabewert

Ein Zeiger auf das Menübandelement, wenn der Benutzer es gerade drückt; andernfalls NULL.

Hinweise

CMFCRibbonBaseElement::GetQuickAccessToolBarID

Ruft die Befehls-ID des Menübandelements ab, wenn es sich in der Symbolleiste für den Schnellzugriff befindet.

virtual UINT GetQuickAccessToolBarID() const;

Rückgabewert

Die Befehls-ID des Menübandelements, wenn es sich in der Symbolleiste für den Schnellzugriff befindet.

Hinweise

CMFCRibbonBaseElement::GetRect

Gibt das umgebende Rechteck des Menübandelements zurück.

CRect GetRect() const;

Rückgabewert

Das umgebende Rechteck des Menübandelements. Die Position des Rechtecks befindet sich in den Koordinaten des übergeordneten Menüband-Steuerelements.

CMFCRibbonBaseElement::GetRegularSize

Gibt die reguläre Größe des Menübandelements zurück.

virtual CSize GetRegularSize(CDC* pDC) = 0;

Parameter

pDC
[in] Ein Zeiger auf einen Gerätekontext.

Rückgabewert

Die normale Größe des Menübandelements.

Hinweise

Hinweis

Die normale Größe ist die maximal mögliche Größe des Menübandelements.

CMFCRibbonBaseElement::GetSize

Gibt die aktuelle Größe des Menübandelements zurück.

virtual CSize GetSize(CDC* pDC);

Parameter

pDC
[in] Ein Zeiger auf einen Gerätekontext.

Rückgabewert

Die aktuelle Größe des Menübandelements.

CMFCRibbonBaseElement::GetText

Gibt den Text zurück, der dem Menübandelement zugeordnet ist.

LPCTSTR GetText() const;

Rückgabewert

Der dem Menübandelement zugeordnete Text.

CMFCRibbonBaseElement::GetToolTipText

Gibt den QuickInfo-Text des Menübandelements zurück.

virtual CString GetToolTipText() const;

Rückgabewert

Der QuickInfo-Text des Menübandelements.

CMFCRibbonBaseElement::GetTopLevelRibbonBar

Ruft die Menübandleiste der obersten Ebene für das Menübandelement ab.

CMFCRibbonBar* GetTopLevelRibbonBar() const;

Rückgabewert

Ein Zeiger auf die Menübandleiste der obersten Ebene für das Menübandelement, wenn die Methode erfolgreich war; andernfalls NULL.

Hinweise

CMFCRibbonBaseElement::HasCompactMode

Gibt an, ob das Menübandelement über einen Komprimierungsmodus verfügt.

virtual BOOL HasCompactMode() const;

Rückgabewert

TRUE, wenn das Menübandelement einen kompakten Modus aufweist. Andernfalls FALSE.

Hinweise

Hinweis

Im Kompaktmodus zeigt ein Element nur ein kleines Bild an.

CMFCRibbonBaseElement::HasIntermediateMode

Gibt an, ob das Menübandelement über einen Zwischenstatus verfügt

virtual BOOL HasIntermediateMode() const;

Rückgabewert

TRUE, wenn das Menübandelement über einen Zwischenmodus verfügt, andernfalls FALSE. Im Zwischenmodus zeigt ein Element ein kleines Bild und Text rechts neben dem Bild an.

Hinweise

CMFCRibbonBaseElement::HasLargeMode

Legt fest, ob das Menübandelement über einen Großbildmodus verfügt.

virtual BOOL HasLargeMode() const;

Rückgabewert

TRUE, wenn das Menübandelement über einen großen Modus verfügt. Andernfalls FALSE.

Hinweise

Im großen Modus kann ein Element die volle Höhe des übergeordneten Panels übernehmen.

CMFCRibbonBaseElement::HasMenu

Gibt an, ob das Menübandelement über ein Menü verfügt.

virtual BOOL HasMenu() const;

Rückgabewert

Gibt immer FALSE zurück.

Hinweise

Standardmäßig gibt diese Methode immer FALSE zurück. Überschreiben Sie diese Methode in einer abgeleiteten Klasse, um anzugeben, ob das Menübandelement über ein Menü verfügt.

CMFCRibbonBaseElement::HitTest

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

virtual CMFCRibbonBaseElement* HitTest(CPoint point);

Parameter

Punkt
[in] Dieser Parameter wird nicht verwendet.

Rückgabewert

Ein Zeiger auf das Menübandelement, falls vorhanden; andernfalls FALSE.

Hinweise

Standardmäßig gibt diese Methode immer einen gültigen Zeiger auf das Menübandelement zurück, wenn sie vorhanden ist. Überschreiben Sie diese Methode, um anzugeben, ob sich der Punkt im Menübandelement befindet.

CMFCRibbonBaseElement::IsAlignByColumn

Gibt an, ob das Menübandelement vertikal an anderen Menübandelementen ausgerichtet ist.

virtual BOOL IsAlignByColumn() const;

Rückgabewert

Gibt immer TRUE zurück.

Hinweise

Standardmäßig gibt diese Methode immer TRUE zurück. Überschreiben Sie diese Methode in einer abgeleiteten Klasse, um anzugeben, ob das abgeleitete Menübandelement vertikal an anderen Menübandelementen ausgerichtet ist.

CMFCRibbonBaseElement::IsAlwaysLargeImage

Gibt an, ob die Bildgröße des Menübandelements immer groß ist.

virtual BOOL IsAlwaysLargeImage() const;

Rückgabewert

TRUE, wenn die Bildgröße des Menübandelements immer groß ist; andernfalls FALSE.

Hinweise

Große Bildgröße beträgt 32 x 32 Pixel.

CMFCRibbonBaseElement::IsAutoRepeatMode

Gibt an, ob sich das Menübandelement im automatischen Wiederholungsmodus befindet.

virtual BOOL IsAutoRepeatMode(int& nDelay) const;

Parameter

nDelay
[in] Dieser Parameter wird nicht verwendet.

Rückgabewert

Gibt immer FALSE zurück.

Hinweise

Standardmäßig gibt diese Methode immer FALSE zurück. Überschreiben Sie diese Methode, um anzugeben, ob sich das Menübandelement im automatischen Wiederholungsmodus befindet.

Im Modus für automatische Wiederholung reagiert das Menübandelement in einem festgelegten Intervall, gemessen in Millisekunden, auf eine dauerhafte Benutzereingabe.

CMFCRibbonBaseElement::IsChecked

Gibt an, ob das Menübandelement aktiviert ist.

virtual BOOL IsChecked() const;

Rückgabewert

TRUE, wenn das Menübandelement aktiviert ist; andernfalls FALSE.

CMFCRibbonBaseElement::IsCompactMode

Gibt an, ob sich das Menübandelement in einem kompakten Modus befindet.

BOOL IsCompactMode() const;

Rückgabewert

TRUE, wenn sich das Menübandelement in einem kompakten Modus befindet; andernfalls FALSE.

CMFCRibbonBaseElement::IsDefaultMenuLook

Gibt an, ob das Menübandelement als Popupbefehl angezeigt wird.

BOOL IsDefaultMenuLook() const;

Rückgabewert

TRUE, wenn das Menübandelement so festgelegt ist, dass es als Popupbefehl angezeigt wird; andernfalls FALSE.

Hinweise

CMFCRibbonBaseElement::IsDisabled

Gibt an, ob das Menübandelement deaktiviert ist.

virtual BOOL IsDisabled() const;

Rückgabewert

TRUE, wenn das Menübandelement deaktiviert ist; andernfalls FALSE.

CMFCRibbonBaseElement::IsDroppedDown

Gibt an, ob das Menübandelement ein Popupmenü anzeigt und abgesetzt wird.

virtual BOOL IsDroppedDown() const;

Rückgabewert

TRUE, wenn das Menübandelement nach unten abgelegt wird und ein Popupmenü anzeigt; andernfalls FALSE.

CMFCRibbonBaseElement::IsFocused

Gibt an, ob das Menübandelement den Fokus hat.

virtual BOOL IsFocused() const;

Rückgabewert

TRUE, wenn das Menübandelement den Fokus hat; andernfalls FALSE.

CMFCRibbonBaseElement::IsGalleryIcon

Gibt an, ob das Menübandelement in einem Menübandkatalog enthalten ist.

virtual BOOL IsGalleryIcon() const;

Rückgabewert

Gibt immer FALSE zurück.

Hinweise

Standardmäßig gibt diese Methode immer FALSE zurück. Überschreiben Sie diese Methode in einer abgeleiteten Klasse, um anzugeben, ob das Menübandelement in einem Menübandkatalog enthalten ist.

CMFCRibbonBaseElement::IsHighlighted

Gibt an, ob das Menübandelement hervorgehoben ist.

virtual BOOL IsHighlighted() const;

Rückgabewert

TRUE, wenn das Menübandelement hervorgehoben ist; andernfalls FALSE.

Hinweise

CMFCRibbonBaseElement::IsIntermediateMode

Gibt an, ob das aktuelle Bild für das Menübandelement Zwischengröße ist.

BOOL IsIntermediateMode() const;

Rückgabewert

TRUE, wenn das Bild für das Menübandelement Zwischengröße ist; andernfalls FALSE.

Hinweise

Die Zwischenbildgröße beträgt 16 x 16 Pixel.

CMFCRibbonBaseElement::IsLargeMode

Gibt an, ob das aktuelle Bild für das Menübandelement groß ist.

BOOL IsLargeMode() const;

Rückgabewert

TRUE, wenn das Bild für das Menübandelement groß ist; andernfalls FALSE.

Hinweise

Große Bildgröße beträgt 32 x 32 Pixel.

CMFCRibbonBaseElement::IsMenuMode

Gibt an, ob das Menübandelement in einem Menü enthalten ist.

BOOL IsMenuMode() const;

Rückgabewert

TRUE, wenn das Menübandelement in einem Menü enthalten ist; andernfalls FALSE.

Hinweise

CMFCRibbonBaseElement::IsPressed

Gibt an, ob der Benutzer auf das Menübandelement geklickt hat.

virtual BOOL IsPressed() const;

Rückgabewert

TRUE, wenn der Benutzer auf das Menübandelement geklickt hat; andernfalls FALSE.

CMFCRibbonBaseElement::IsQATMode

Gibt an, ob das Menübandelement in der Symbolleiste für den Schnellzugriff enthalten ist.

BOOL IsQATMode() const;

Rückgabewert

TRUE, wenn das Menübandelement in der Symbolleiste für den Schnellzugriff enthalten ist; andernfalls FALSE.

Hinweise

CMFCRibbonBaseElement::IsSeparator

Gibt an, ob das Menübandelement ein Anzeigetrennzeichen ist.

virtual BOOL IsSeparator() const;

Rückgabewert

TRUE, wenn das Menübandelement ein Anzeigetrennzeichen ist; andernfalls FALSE.

Hinweise

CMFCRibbonBaseElement::IsShowGroupBorder

Gibt an, ob das Menübandelement in einer Gruppe enthalten ist, die einen gemeinsamen Rahmen anzeigt.

BOOL IsShowGroupBorder() const;

Rückgabewert

TRUE, wenn das Menübandelement in einer Gruppe enthalten ist, die einen gemeinsamen Rahmen anzeigt; andernfalls FALSE.

Hinweise

CMFCRibbonBaseElement::IsShowTooltipOnBottom

Gibt an, ob die QuickInfo unter dem Menübandelement angezeigt wird.

virtual BOOL IsShowTooltipOnBottom() const;

Rückgabewert

TRUE, wenn die QuickInfo unter dem Menübandelement angezeigt wird; FALSE, wenn die QuickInfo in der Nähe des Zeigers angezeigt wird.

Hinweise

CMFCRibbonBaseElement::IsTabStop

Gibt an, ob das Menübandelement mit der Tastatur ausgewählt werden kann.

virtual BOOL IsTabStop() const;

Rückgabewert

Gibt immer TRUE zurück.

Hinweise

Standardmäßig gibt diese Methode immer TRUE zurück. Überschreiben Sie diese Methode, um anzugeben, ob das Menübandelement mit der Tastatur ausgewählt werden kann.

CMFCRibbonBaseElement::IsTextAlwaysOnRight

Gibt an, ob der Text für das Menübandelement rechts angezeigt wird.

BOOL IsTextAlwaysOnRight() const;

Rückgabewert

TRUE, wenn der Text für das Menübandelement rechts angezeigt wird; andernfalls FALSE.

Hinweise

CMFCRibbonBaseElement::IsVisible

Gibt an, ob das Menübandelement derzeit angezeigt wird.

BOOL IsVisible() const;

Rückgabewert

TRUE, wenn das Menübandelement zurzeit angezeigt wird; andernfalls FALSE.

Hinweise

CMFCRibbonBaseElement::IsWholeRowHeight

Gibt an, ob die Anzeigehöhe des Menübandelements mit der Anzeigehöhe des Menübandpanels übereinstimmt, das es enthält.

virtual BOOL IsWholeRowHeight() const;

Rückgabewert

Gibt immer FALSE zurück.

Hinweise

Standardmäßig gibt diese Methode immer FALSE zurück. Überschreiben Sie diese Methode, um anzugeben, ob die Anzeigehöhe des Menübandelements mit der Anzeigehöhe des Menübandpanels identisch ist, das sie enthält.

CMFCRibbonBaseElement::NotifyCommand

Sendet eine Befehlsbenachrichtigung an das übergeordnete Fenster des Menübandelements.

BOOL NotifyCommand(BOOL bWithDelay = FALSE);

Parameter

bWithDelay
[in] TRUE, um die Befehlsbenachrichtigung zur Nachrichtenwarteschlange des übergeordneten Fensters hinzuzufügen; FALSE, um die Nachricht sofort an das übergeordnete Fenster zu senden.

Rückgabewert

TRUE, wenn die Nachricht gesendet wurde; andernfalls FALSE.

Hinweise

CMFCRibbonBaseElement::NotifyHighlightListItem

Benachrichtigt das übergeordnete Fenster der Menübandleiste, wenn ein Benutzer ein Menübandelement hervorhebung, das sich in einer Liste befindet.

virtual void NotifyHighlightListItem(int nIndex);

Parameter

nIndex
[in] Der Index des Menübandelements in der Liste.

Hinweise

CMFCRibbonBaseElement::OnAddToQAToolbar

Fügt das Menübandelement zur angegebenen Symbolleiste für den Schnellzugriff hinzu.

virtual BOOL OnAddToQAToolbar(CMFCRibbonQuickAccessToolBar& qat);

Parameter

Qat
[in] Die Symbolleiste für den Schnellzugriff.

Rückgabewert

Gibt immer TRUE zurück, der angibt, dass das Menübandelement zur Symbolleiste für den Schnellzugriff hinzugefügt wurde.

Hinweise

CMFCRibbonBaseElement::OnAfterChangeRect

Aktualisiert die QuickInfo für das Menübandelement.

virtual void OnAfterChangeRect(CDC* pDC);

Parameter

pDC
[in] Dieser Parameter wird nicht verwendet.

Hinweise

Standardmäßig aktualisiert diese Methode die QuickInfo für das Menübandelement. Überschreiben Sie diese Methode, um das Menübandelement zu aktualisieren, nachdem sich das Anzeigerechteck geändert hat.

CMFCRibbonBaseElement::OnAutoRepeat

Aktualisiert das Menübandelement als Reaktion auf dauerhafte Benutzereingaben.

virtual BOOL OnAutoRepeat();

Rückgabewert

Gibt immer FALSE zurück.

Hinweise

Standardmäßig gibt diese Methode immer FALSE zurück. Überschreiben Sie diese Methode, um nachhaltige Benutzereingaben zu verarbeiten.

CMFCRibbonBaseElement::OnCalcTextSize

Berechnet die Größe des Texts für das Menübandelement.

virtual void OnCalcTextSize(CDC* pDC);

Parameter

pDC
[in] Dieser Parameter wird nicht verwendet.

Hinweise

Standardmäßig führt diese Methode nichts aus. Überschreiben Sie diese Methode, um die Größe des Texts für das Menübandelement zu berechnen.

CMFCRibbonBaseElement::OnChangeMenuHighlight

Wird vom Framework aufgerufen, wenn sich die Hervorhebung für ein Menübandelement ändert, das sich in einem Menü befindet.

virtual void OnChangeMenuHighlight(CMFCRibbonPanelMenuBar* pPanelMenuBar
    CMFCRibbonBaseElement* pHot);

Parameter

pPanelMenuBar
[in] Dieser Parameter wird nicht verwendet.

phot
[in] Dieser Parameter wird nicht verwendet.

Hinweise

Standardmäßig führt diese Methode nichts aus. Überschreiben Sie diese Methode, um ein Menübandelement zu aktualisieren, das sich in einem Menü befindet, wenn sich die Hervorhebung ändert.

CMFCRibbonBaseElement::OnDraw

Wird vom Framework aufgerufen, um das Menübandelement zu zeichnen.

virtual void OnDraw(CDC* pDC) = 0;

Parameter

pDC
[in] Ein Zeiger auf einen Gerätekontext.

Hinweise

Überschreiben Sie diese Methode in einer abgeleiteten Klasse, wenn Sie die Zeichnung eines bestimmten Menübandelements anpassen möchten.

CMFCRibbonBaseElement::OnDrawKeyTip

Vom Framework aufgerufen, um die Zugriffstasteninfo für das Menübandelement zu zeichnen.

virtual void OnDrawKeyTip(
    CDC* pDC,
    const CRect& rect,
    BOOL bIsMenu);

Parameter

pDC
[in] Zeiger auf einen Gerätekontext.

rect
[in] Begrenzungsrechteck für die Zugriffstasteninfo.

bIsMenu
[in] TRUE, wenn die Zugriffstasteninfo für eine Popupmenüschaltfläche vorgesehen ist; andernfalls FALSE.

Hinweise

CMFCRibbonBaseElement::OnDrawMenuImage

Wird vom Framework aufgerufen, wenn das Menübild für das Menübandelement gezeichnet wird.

virtual BOOL OnDrawMenuImage(
    CDC* pDC,
    CRect rect);

Parameter

pDC
[in] Zeiger auf einen Gerätekontext.

rect
[in] Menübildrechteck.

Rückgabewert

Gibt immer TRUE zurück, um anzugeben, dass das Bild gezeichnet wurde.

Hinweise

CMFCRibbonBaseElement::OnDrawOnList

Wird vom Framework aufgerufen, um das Menübandelement in einem Befehlslistenfeld zu zeichnen.

virtual void OnDrawOnList(
    CDC* pDC,
    CString strText,
    int nTextOffset,
    CRect rect,
    BOOL bIsSelected,
    BOOL bHighlighted);

Parameter

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

strText
[in] Der Anzeigetext.

nTextOffset
[in] Abstand (in Pixel) von der linken Seite des Listenfelds zum Anzeigetext.

rect
[in] Das Anzeigerechteck für das Menübandelement.

bIsSelected
[in] Dieser Parameter wird nicht verwendet.

bHighlighted
[in] Dieser Parameter wird nicht verwendet.

Hinweise

Im Listenfeld "Befehle" werden Menübandelemente angezeigt, damit Benutzer die Symbolleiste für den Schnellzugriff anpassen können.

CMFCRibbonBaseElement::OnKey

Wird vom Framework aufgerufen, wenn der Benutzer eine Zugriffstasteninfo drückt und das Menübandelement den Fokus hat.

virtual BOOL OnKey(BOOL bIsMenuKey);

Parameter

bIsMenuKey
[in] TRUE, wenn die Zugriffstasteninfo ein Popupmenü anzeigt; andernfalls FALSE.

Rückgabewert

TRUE, wenn das Ereignis behandelt wurde; andernfalls FALSE.

Hinweise

CMFCRibbonBaseElement::OnMenuKey

Wird vom Framework aufgerufen, wenn der Benutzer eine Menütasteninfo im Hauptbereich drückt.

virtual BOOL OnMenuKey(UINT nUpperChar);

Parameter

nUpperChar
[in] Dieser Parameter wird nicht verwendet.

Rückgabewert

Gibt immer FALSE zurück.

Hinweise

Standardmäßig gibt diese Methode immer FALSE zurück. Überschreiben Sie diese Methode, um zu reagieren, wenn ein Benutzer eine Menütasteninfo im Hauptbereich drückt.

CMFCRibbonBaseElement::OnProcessKey

Wird vom Framework aufgerufen, wenn der Benutzer eine Tastenkombination drückt.

virtual BOOL OnProcessKey(UINT nChar);

Parameter

nChar
[in] Dieser Parameter wird nicht verwendet.

Rückgabewert

Gibt immer FALSE zurück.

Hinweise

Überschreiben Sie diese Methode, wenn das Menübandelement eine Tastenkombination verarbeiten soll.

CMFCRibbonBaseElement::OnRTLChanged

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

virtual void OnRTLChanged(BOOL bIsRTL);

Parameter

bIsRTL
[in] Dieser Parameter wird nicht verwendet.

Hinweise

Standardmäßig führt diese Methode nichts aus. Überschreiben Sie diese Methode, um das Menübandelement anzupassen, wenn sich die Layoutrichtung ändert. Die Standardlayoutrichtung ist von links nach rechts.

CMFCRibbonBaseElement::OnSetFocus

Wird vom Framework aufgerufen, wenn ein Menübandelement den Eingabefokus empfängt oder verliert.

virtual void OnSetFocus(BOOL B);

Hinweise

Überschreiben Sie diese Methode in einer abgeleiteten Klasse, wenn Ihre Anwendung eine Änderung im Fokus eines Menübandelements behandeln soll.

CMFCRibbonBaseElement::OnShow

Wird vom Framework aufgerufen, um das Menübandelement ein- oder auszublenden.

virtual void OnShow(BOOL bShow);

Parameter

bShow
[in] Dieser Parameter wird nicht verwendet.

Hinweise

Standardmäßig führt diese Methode nichts aus. Überschreiben Sie diese Methode, um das Menübandelement ein- oder auszublenden.

CMFCRibbonBaseElement::OnShowPopupMenu

Wird vom Framework aufgerufen, bevor das Menübandelement ein Popupmenü anzeigt.

virtual void OnShowPopupMenu();

Hinweise

Mit dieser Methode wird das übergeordnete Fenster der Menübandleiste benachrichtigt, dass das Menübandelement ein Popupmenü anzeigt.

CMFCRibbonBaseElement::P ostMenuCommand

Schließt das Popupmenü für das Menübandelement und sendet eine Nachricht in der Nähe an das übergeordnete Menü.

void PostMenuCommand(UINT uiCmdId);

Parameter

uiCmdId
[in] Der Parameter wird nicht verwendet.

Hinweise

Die Schließnachricht wird nur gesendet, wenn sich das Menübandelement in einem Popupmenü befindet.

CMFCRibbonBaseElement::Redraw

Aktualisiert die Anzeige für das Menübandelement.

virtual void Redraw();

Hinweise

Mit dieser Methode wird das Anzeigerechteck für das Menübandelement neu gezeichnet, indem CWnd::RedrawWindow mit den RDW_INVALIDATE, RDW_ERASE und RDW_UPDATENOW Flags aufgerufen wird.

CMFCRibbonBaseElement::SetACCData

Legt die Barrierefreiheitsdaten für das Menübandelement fest.

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

Parameter

pParent
Das übergeordnete Fenster für die Menübandelement.

data
Die Barrierefreiheitsdaten für das Menübandelement.

Rückgabewert

Gibt immer TRUE zurück.

Hinweise

Standardmäßig legt diese Methode die Barrierefreiheitsdaten für das Menübandelement fest und gibt immer TRUE zurück. Setzen Sie diese Methode außer Kraft, um die Barrierefreiheitsdaten festzulegen und einen Wert zurückzugeben, der den Erfolg oder einen Fehler angibt.

CMFCRibbonBaseElement::SetCompactMode

Legt die Anzeigegröße für das Menübandelement fest.

virtual void SetCompactMode(BOOL bCompactMode = TRUE);

Parameter

bCompactMode
[in] TRUE, um die Anzeigegröße des Menübandelements zu verringern; FALSE, um die Anzeigegröße des Menübandelements zu erhöhen.

Hinweise

In der folgenden Tabelle wird die Logik für diese Methode zusammengefasst.

bCompactMode	Aktuelle Größe des Menübandelements	Neue Größe des Menübandelements
TRUE	Kompakt	Keine Änderung.
TRUE	Zwischenstufe	Komprimieren, falls möglich.
TRUE	Large	Zwischenstufe, wenn es möglich ist.
FALSE	Kompakt	Zwischen, wenn es möglich ist; andernfalls groß.

CMFCRibbonBaseElement::SetData

Ordnet ein Datenelement dem Menübandelement zu.

void SetData(DWORD_PTR dwData);

Parameter

dwData
[in] Der Datenwert.

CMFCRibbonBaseElement::SetDefaultMenuLook

Legt fest, dass das Menübandelement als Popupbefehl angezeigt wird.

void SetDefaultMenuLook(BOOL bIsDefaultMenuLook = TRUE);

Parameter

bIsDefaultMenuLook
[in] TRUE, um das Menübandelement so festzulegen, dass es als Popupbefehl angezeigt wird; andernfalls FALSE.

Hinweise

CMFCRibbonBaseElement::SetDescription

Legt die Beschreibung für das Menübandelement fest.

virtual void SetDescription(LPCTSTR lpszText);

Parameter

lpszText
[in] Die Beschreibung für das Menübandelement.

Hinweise

Das Framework zeigt die neue Beschreibung entweder auf der Statusleiste oder in der QuickInfo oder unter der Menüschaltfläche an.

CMFCRibbonBaseElement::SetID

Legt die Befehls-ID des Menübandelements fest.

virtual void SetID(UINT nID);

Parameter

Nid
[in] Die Befehls-ID.

CMFCRibbonBaseElement::SetInitialMode

Legt die anfängliche Anzeigegröße für das Menübandelement fest.

virtual void SetInitialMode(BOOL bOneRow = FALSE);

Parameter

bOneRow
[in] TRUE, um die Anzeigegröße für das Menübandelement auf komprimieren oder zwischenzustufen; andernfalls FALSE.

Hinweise

Die Anzeigegröße von Menübandelementen kann kompakt, zwischen oder groß sein.

CMFCRibbonBaseElement::SetKeys

Legt die Zugriffstasteninfos für das Menübandelement fest.

virtual void SetKeys(
    LPCTSTR lpszKeys,
    LPCTSTR lpszMenuKeys=NULL);

Parameter

lpszKeys
[in] Die Zugriffstasteninfo für das Menübandelement.

lpszMenuKeys
[in] Die Zugriffstasteninfo für das Popupmenü des Menübandelements.

CMFCRibbonBaseElement::SetOriginal

Legt das ursprüngliche Menübandelement für das Menübandelement fest.

virtual void SetOriginal(CMFCRibbonBaseElement* pOriginal);

Parameter

pOriginal
[in] Zeiger auf ein Menübandelement.

Hinweise

Menübandelemente, die in einen anderen Container kopiert werden, behalten einen Zeiger auf das ursprüngliche Menübandelement bei.

CMFCRibbonBaseElement::SetParentCategory

Legt die übergeordnete Kategorie für das Menübandelement fest.

virtual void SetParentCategory(CMFCRibbonCategory* pParent);

Parameter

pParent
[in] Zeiger auf eine Menübandkategorie.

Hinweise

Die Registerkartengruppen in Menübandsteuerelementen werden als Kategorien bezeichnet.

CMFCRibbonBaseElement::SetParentMenu

Legt den übergeordneten Menücontainer für das Menübandelement fest.

virtual void SetParentMenu(CMFCRibbonPanelMenuBar* pMenuBar);

Parameter

pMenuBar
[in] Das übergeordnete Menü.

Hinweise

CMFCRibbonBaseElement::SetParentRibbonBar

Legt die übergeordnete Menübandleiste für das Menübandelement fest.

virtual void SetParentRibbonBar(CMFCRibbonBar* pRibbonBar);

Parameter

pRibbonBar
[in] Zeigen Sie auf die übergeordnete Menübandleiste.

Hinweise

CMFCRibbonBaseElement::SetRect

Legt die Abmessungen des Anzeigerechtecks für das Menübandelement fest.

void SetRect(CRect rect);

Parameter

rect
[in] Die Abmessungen des Rechtecks.

Hinweise

CMFCRibbonBaseElement::SetText

Legt den Text und die Zugriffstasteninfo für das Menübandelement fest.

virtual void SetText(LPCTSTR lpszText);

Parameter

lpszText
[in] Der Text und die Zugriffstaste für das Menübandelement.

Hinweise

Um die Zugriffstasteninfo für das Menübandelement festzulegen, fügen Sie die Neueline-Escapesequenz gefolgt von den Zugriffstasteninfozeichen an lpszText an.

Beispiel

//Set the text for the ribbon element
SetText(_T("Margins"))
//Set the text and a single-letter keytip
SetText(_T("Margins\nm"))
//Set the text and a multiple-letter keytip
SetText(_T("Line Numbers\nln"))

CMFCRibbonBaseElement::SetTextAlwaysOnRight

Legt den Text für das Menübandelement fest, das auf der rechten Seite angezeigt werden soll.

virtual void SetTextAlwaysOnRight(BOOL bSet = TRUE);

Parameter

bSet
[in] TRUE, um den Text auf der rechten Seite anzuzeigen; andernfalls FALSE.

Hinweise

CMFCRibbonBaseElement::SetToolTipText

Legt den QuickInfo-Text für das Menübandelement fest.

virtual void SetToolTipText(LPCTSTR lpszText);

Parameter

lpszText
[in] Der QuickInfo-Text.

CMFCRibbonBaseElement::SetVisible

Legt die Sichtbarkeit des Menübandelements fest.

void SetVisible(BOOL bIsVisible);

Parameter

bIsVisible
[in] TRUE zum Anzeigen des Menübandelements; FALSE, um das Menübandelement auszublenden.

Hinweise

CMFCRibbonBaseElement::StretchHorizontally

Streckt die Breite des Menübandelements.

virtual void StretchHorizontally();

Hinweise

Standardmäßig generiert diese Methode einen Assertionsfehler in Debugbuilds und sollte daher nicht aufgerufen werden. Überschreiben Sie diese Methode, um die Breite des Menübandelements zu strecken.

CMFCRibbonBaseElement::StretchToWholeRow

Ändert die Anzeigehöhe des Menübandelements in die angegebene Zeilenhöhe.

virtual BOOL StretchToWholeRow(
    CDC* pDC,
    int nHeight);

Parameter

pDC
[in] Dieser Parameter wird nicht verwendet.

nHeight
[in] Die Höhe der Zeile.

Rückgabewert

TRUE, wenn die Anzeigehöhe festgelegt wurde; andernfalls FALSE.

Hinweise

Überschreiben Sie diese Methode, um die Anzeigehöhe des Menübandelements in die angegebene Zeilenhöhe zu ändern.

CMFCRibbonBaseElement::UpdateTooltipInfo

Aktualisiert den QuickInfo-Text mithilfe der Befehlsressource für das Menübandelement.

virtual void UpdateTooltipInfo();

Hinweise

CMFCRibbonBaseElement::HasFocus

Gibt an, ob das übergeordnete Element den Tastaturfokus hat.

virtual BOOL HasFocus() const;

Freigeben über

CMFCRibbonBaseElement-Klasse

Syntax

Member

Öffentliche Konstruktoren

Öffentliche Methoden

Geschützte Methoden

Hinweise

Beispiel

Vererbungshierarchie

Anforderungen

CMFCRibbonBaseElement::AddToKeyList

Parameter

Hinweise

CMFCRibbonBaseElement::AddToListBox

Parameter

Rückgabewert

Hinweise

CMFCRibbonBaseElement::CanBeAddedToQuickAccessToolBar

Rückgabewert

Hinweise

CMFCRibbonBaseElement::CanBeCompacted

Rückgabewert

Hinweise

CMFCRibbonBaseElement::CanBeStretched

Rückgabewert

Hinweise

CMFCRibbonBaseElement::CanBeStretchedHorizontally

Rückgabewert

Hinweise

CMFCRibbonBaseElement::CleanUpSizes

Hinweise

CMFCRibbonBaseElement::ClosePopupMenu

Hinweise

CMFCRibbonBaseElement::CopyFrom

Parameter

Hinweise

CMFCRibbonBaseElement::D estroyCtrl

Hinweise

CMFCRibbonBaseElement::D rawImage

Parameter

Hinweise

CMFCRibbonBaseElement::Find

Parameter

Rückgabewert

Hinweise

CMFCRibbonBaseElement::FindByData

Parameter

Rückgabewert

Hinweise

CMFCRibbonBaseElement::FindByID

Parameter

Rückgabewert

Hinweise

CMFCRibbonBaseElement::FindByOriginal

Parameter

Rückgabewert

Hinweise

CMFCRibbonBaseElement::GetCompactSize

Parameter

Rückgabewert

CMFCRibbonBaseElement::GetData

Rückgabewert

CMFCRibbonBaseElement::GetDescription

Rückgabewert

CMFCRibbonBaseElement::GetDroppedDown

Rückgabewert

Hinweise

CMFCRibbonBaseElement::GetElements

Parameter

Hinweise

CMFCRibbonBaseElement::GetElementsByID

Parameter

Hinweise

CMFCRibbonBaseElement::GetHighlighted

Rückgabewert

Hinweise

CMFCRibbonBaseElement::GetID

Rückgabewert

CMFCRibbonBaseElement::GetImageSize