CMFCRibbonColorButton-Klasse

Die CMFCRibbonColorButton -Klasse implementiert eine Farbenschaltfläche, die einer Menübandleiste hinzugefügt werden kann. Die Menüband-Farbenschaltfläche zeigt ein Dropdownmenü an, das eine oder mehrere Farbpaletten enthält.

Syntax

class CMFCRibbonColorButton : public CMFCRibbonGallery

Member

Öffentliche Konstruktoren

Öffentliche Methoden

Hinweise

Die Farbenschaltfläche im Menüband zeigt eine Farbleiste an, wenn ein Benutzer drauf drückt. Standardmäßig enthält diese Farbleiste eine Farbauswahlpalette, die als normaler Farbbereich bezeichnet wird. Optional kann die Farbleiste eine Schaltfläche Automatisch , die dem Benutzer die Auswahl einer Standardfarbe ermöglicht, und eine Schaltfläche Weitere anzeigen, die eine Popupfarbpalette anzeigt, die weitere Farben enthält.

Beispiel

Das folgende Beispiel veranschaulicht die Verwendung verschiedener Methoden in der CMFCRibbonColorButton -Klasse. Im Beispiel wird gezeigt, wie ein CMFCRibbonColorButton -Objekt konstruiert wird, das große Bild festgelegt wird, die Schaltfläche Automatisch aktiviert wird, die Schaltfläche Weitere aktiviert wird, die Spaltenanzahl festgelegt wird, die Größe aller Farbelemente festgelegt wird, die auf der Farbleiste angezeigt werden, dem normalen Farbbereich eine Gruppe Farben hinzugefügt wird, und eine Liste mit RGB-Werten für die Anzeige im Farbbereich des Dokuments angegeben wird. Dieser Codeausschnitt ist Teil des Draw Client-Beispiels.

// Create the "Paper Color" button
CMFCRibbonColorButton *pBtnPaperColor = new CMFCRibbonColorButton(ID_VIEW_PAPERCOLOR, _T("Paper Color\ng"), TRUE, 13, 1);
pBtnPaperColor->SetAlwaysLargeImage();
pBtnPaperColor->EnableAutomaticButton(_T("&Automatic"), RGB(255, 255, 255));
pBtnPaperColor->EnableOtherButton(_T("&More Colors..."), _T("More Colors"));
pBtnPaperColor->SetColumns(10);
pBtnPaperColor->SetColorBoxSize(CSize(17, 17));
// CList<COLORREF,COLORREF> m_lstMainColors
pBtnPaperColor->AddColorsGroup(_T("Theme Colors"), m_lstMainColors, TRUE);
// CList<COLORREF,COLORREF> m_lstAdditionalColors
pBtnPaperColor->AddColorsGroup(_T(""), m_lstAdditionalColors, FALSE);
// CList<COLORREF,COLORREF> m_lstStandardColors
pBtnPaperColor->AddColorsGroup(_T("Standard Colors"), m_lstStandardColors, TRUE);
CList<COLORREF, COLORREF> lstColors;
lstColors.AddTail(RGB(255, 0, 0));
lstColors.AddTail(RGB(0, 255, 0));
lstColors.AddTail(RGB(0, 0, 255));
pBtnPaperColor->SetDocumentColors(_T("Document Colors"), lstColors);

Vererbungshierarchie

CObject

CMFCRibbonBaseElement

CMFCRibbonButton

CMFCRibbonGallery

CMFCRibbonColorButton

Anforderungen

Header: afxribboncolorbutton.h

CMFCRibbonColorButton::AddColorsGroup

Fügt dem normalen Farbbereich eine Gruppe Farben hinzu.

void AddColorsGroup(
    LPCTSTR lpszName,
    const CList<COLORREF,COLORREF>& lstColors,
    BOOL bContiguousColumns=FALSE);

Parameter

lpszName
[in] Der Gruppenname.

lstColors
[in] Die Liste der Farben.

bContiguousColumns
[in] Steuert, wie die Farbelemente in der Gruppe angezeigt werden. Wenn WAHR, werden die Farbelemente ohne vertikalen Abstand gezeichnet. Wenn FALSE, werden die Farbelemente mit einem vertikalen Abstand gezeichnet.

Hinweise

Verwenden Sie diese Funktion, um das Farb-Popup mehrere Farbengruppen anzuzeigen. Sie können steuern, wie die Farben in der Gruppe angezeigt werden.

CMFCRibbonColorButton::CMFCRibbonColorButton

Erstellt ein CMFCRibbonColorButton-Objekt.

CMFCRibbonColorButton();

CMFCRibbonColorButton(
    UINT nID,
    LPCTSTR lpszText,
    int nSmallImageIndex,
    COLORREF color = RGB(0, 0, 0));

CMFCRibbonColorButton(
    UINT nID,
    LPCTSTR lpszText,
    BOOL bSimpleButtonLook,
    int nSmallImageIndex,
    int nLargeImageIndex,
    COLORREF color = RGB(0, 0, 0));

Parameter

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

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

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

color
[in] Die Farbe der Schaltfläche (standardmäßig schwarz).

bSimpleButtonLook
[in] Wenn WAHR, wird die Schaltfläche als einfaches Rechteck gezeichnet.

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

Rückgabewert

Bemerkungen

CMFCRibbonColorButton::EnableAutomaticButton

Gibt an, ob die Schaltfläche Automatisch aktiviert ist.

void EnableAutomaticButton(
    LPCTSTR lpszLabel,
    COLORREF colorAutomatic,
    BOOL bEnable=TRUE,
    LPCTSTR lpszToolTip=NULL,
    BOOL bOnTop=TRUE,
    BOOL bDrawBorder=FALSE);

Parameter

lpszLabel
[in] Die Bezeichnung für die Schaltfläche "Automatisch" .

colorAutomatic
[in] Ein RGB-Wert, der die Standardfarbe der automatischen Schaltfläche angibt.

bEnable
[in] TRUE, wenn die Schaltfläche "Automatisch " aktiviert ist; FALSE, wenn sie deaktiviert ist.

lpszToolTip
[in] Die QuickInfo der Schaltfläche "Automatisch" .

bOnTop
[in] Gibt an, ob sich die Schaltfläche "Automatisch" oben in der Farbpalette befindet.

bDrawBorder
[in] TRUE, wenn die Anwendung einen Rahmen um die Farbleiste auf der Menübandfarbschaltfläche zeichnet. In der Farbleiste wird die aktuell ausgewählte Farbe angezeigt. FALSE, wenn die Anwendung keinen Rahmen zeichnet

CMFCRibbonColorButton::EnableOtherButton

Aktiviert die Schaltfläche Weitere .

void EnableOtherButton(
    LPCTSTR lpszLabel,
    LPCTSTR lpszToolTip=NULL);

Parameter

lpszLabel
Die Beschriftung der Schaltfläche.

lpszToolTip
Der QuickInfo-Text für die Schaltfläche "Sonstige ".

Hinweise

Die Schaltfläche "Sonstige " ist die Schaltfläche, die unter der Gruppe der Farben angezeigt wird. Wenn der Benutzer auf die Schaltfläche "Sonstige " klickt, wird ein Farbdialogfeld angezeigt.

CMFCRibbonColorButton::GetAutomaticColor

Ruft die aktuelle Farbe für automatische Schaltflächen ab.

COLORREF GetAutomaticColor() const;

Rückgabewert

Ein RGB-Farbwert, der die aktuelle Farbe der automatischen Schaltfläche darstellt.

Hinweise

Die Farbe der automatischen Schaltfläche wird durch den Parameter festgelegt, der colorAutomatic an die CMFCRibbonColorButton::EnableAutomaticButton Methode übergeben wird.

CMFCRibbonColorButton::GetColor

Gibt die aktuell ausgewählte Farbe zurück.

COLORREF GetColor() const;

Rückgabewert

Die farbe, die durch Klicken auf die Schaltfläche ausgewählt wurde.

CMFCRibbonColorButton::GetColorBoxSize

Gibt die Größe der Farbelemente zurück, die in der Farbleiste angezeigt werden.

CSize GetColorBoxSize() const;

Rückgabewert

Die Größe der Farbschaltflächen in der Dropdownfarbpalette.

CMFCRibbonColorButton::GetColumns

Ruft die Anzahl der Elemente in einer Zeile des Katalogs der Menübandfarbschaltfläche ab.

int GetColumns() const;

Rückgabewert

Gibt die Anzahl der Symbole in jeder Zeile zurück.

Hinweise

CMFCRibbonColorButton::GetHighlightedColor

Gibt die Farbe des aktuell ausgewählten Elements in der Popupfarbpalette zurück.

COLORREF GetHighlightedColor() const;

Rückgabewert

Die Farbe des aktuell ausgewählten Elements in der Popupfarbpalette.

CMFCRibbonColorButton::RemoveAllColorGroups

Entfernt alle Farbgruppen aus dem normalen Farbbereich.

void RemoveAllColorGroups();

CMFCRibbonColorButton::SetColor

Wählt eine Farbe aus dem normalen Farbbereich aus.

void SetColor(COLORREF color);

Parameter

color
[in] Eine farbe, die festgelegt werden soll.

CMFCRibbonColorButton::SetColorBoxSize

Legt die Größe aller Farbelemente fest, die in der Farbleiste angezeigt werden.

void SetColorBoxSize(CSize sizeBox);

Parameter

sizeBox
[in] Die neue Größe der Farbschaltflächen in der Farbpalette.

CMFCRibbonColorButton::SetColorName

Legt einen neuen Namen für eine angegebene Farbe fest.

static void __stdcall SetColorName(
    COLORREF color,
    const CString& strName);

Parameter

color
[in] Der RGB-Wert einer Farbe.

strName
[in] Der neue Name für die angegebene Farbe.

Hinweise

Da sie aufgerufen wird CMFCColorBar::SetColorName, ändert diese Methode den Namen der angegebenen Farbe in allen CMFCColorBar Objekten in Ihrer Anwendung.

CMFCRibbonColorButton::SetColumns

Legt die Anzahl der Spalten fest, die in der Tabelle der Farben angezeigt werden, die dem Benutzer während des Farbauswahlprozesses angezeigt werden.

void SetColumns(int nColumns);

Parameter

nColumns
[in] Die Anzahl der Farbsymbole, die in jeder Zeile angezeigt werden sollen.

Hinweise

CMFCRibbonColorButton::SetDocumentColors

Gibt eine Liste mit RGB-Werten für die Anzeige im Farbbereich des Dokuments an.

void SetDocumentColors(
    LPCTSTR lpszLabel,
    CList<COLORREF,COLORREF>& lstColors);

Parameter

lpszLabel
[in] Der text, der mit den Dokumentfarben angezeigt werden soll.

lstColors
[in] Ein Verweis auf eine Liste von RGB-Werten.

CMFCRibbonColorButton::SetPalette

Gibt die Standardfarben an, die in der Farbtabelle angezeigt werden sollen, die von der Farbschaltfläche angezeigt wird.

void SetPalette(CPalette* pPalette);

Parameter

pPalette
[in] Ein Zeiger auf eine Farbpalette.

Hinweise

CMFCRibbonColorButton::UpdateColor

Wird vom Framework aufgerufen, wenn der Benutzer eine Farbe aus der Farbtabelle auswählt, die angezeigt wird, wenn der Benutzer auf die Farbschaltfläche klickt.

void UpdateColor(COLORREF color);

Parameter

color
[in] Vom Benutzer ausgewählte Farbe.

Hinweise

Die CMFCRibbonColorButton::UpdateColor Methode ändert die Farbe der aktuell ausgewählten Schaltfläche und benachrichtigt das übergeordnete Element durch Senden einer WM_COMMAND Nachricht mit einer BN_CLICKED Standardbenachrichtigung. Verwenden Sie die CMFCRibbonColorButton::GetColor-Methode , um die ausgewählte Farbe abzurufen.

Siehe auch

Hierarchiediagramm
Klassen
CMFCRibbonGallery-Klasse