CMFCColorBar-Klasse

  • Artikel

Die CMFCColorBar Klasse stellt eine Andocksteuerungsleiste dar, die Farben in einem Dokument oder einer Anwendung auswählen kann.

Syntax

class CMFCColorBar : public CMFCPopupMenuBar

Member

Geschützte Konstruktoren

Name Beschreibung
CMFCColorBar::CMFCColorBar Erstellt ein CMFCColorBar-Objekt.

Öffentliche Methoden

Name Beschreibung
CMFCColorBar::ContextToSize Berechnet die vertikalen und horizontalen Ränder, die erforderlich sind, um die Schaltflächen im Farbbalken-Steuerelement zu enthalten, und passt dann die Position dieser Schaltflächen an.
CMFCColorBar::CreateControl Erstellt ein Farbbalken-Steuerelementfenster, fügt es an das CMFCColorBar Objekt an und ändert die Größe des Steuerelements so, dass es die angegebene Farbpalette enthält.
CMFCColorBar::Create Erstellt ein Farbbalken-Steuerelementfenster und fügt es an das CMFCColorBar Objekt an.
CMFCColorBar::EnableAutomaticButton Blendet die automatische Schaltfläche ein oder aus.
CMFCColorBar::EnableOtherButton Aktiviert oder deaktiviert die Anzeige eines Dialogfelds, mit dem der Benutzer weitere Farben auswählen kann.
CMFCColorBar::GetColor Ruft die aktuell ausgewählte Farbe ab.
CMFCColorBar::GetCommandID Ruft die Befehls-ID des aktuellen Farbbalken-Steuerelements ab.
CMFCColorBar::GetHighlightedColor Ruft die Farbe ab, die angibt, dass eine Farbschaltfläche den Fokus hat; das heißt, die Schaltfläche ist heiß.
CMFCColorBar::GetHorzMargin Ruft den horizontalen Rand ab, bei dem es sich um den Abstand zwischen der linken oder rechten Farbzelle und der Clientbereichsgrenze handelt.
CMFCColorBar::GetVertMargin Ruft den vertikalen Rand ab, bei dem es sich um den Abstand zwischen der oberen oder unteren Farbzelle und der Clientbereichsgrenze handelt.
CMFCColorBar::IsTearOff Gibt an, ob der aktuelle Farbbalken andockbar ist.
CMFCColorBar::SetColor Legt die aktuell ausgewählte Farbe fest.
CMFCColorBar::SetColorName Legt einen neuen Namen für eine angegebene Farbe fest.
CMFCColorBar::SetCommandID Legt eine neue Befehls-ID für ein Farbbalken-Steuerelement fest.
CMFCColorBar::SetDocumentColors Legt die Liste der Farben fest, die im aktuellen Dokument verwendet werden.
CMFCColorBar::SetHorzMargin Legt den horizontalen Rand fest, bei dem es sich um den Abstand zwischen der linken oder rechten Farbzelle und der Clientbereichsgrenze handelt.
CMFCColorBar::SetVertMargin Legt den vertikalen Rand fest, bei dem es sich um den Abstand zwischen der oberen oder unteren Farbzelle und der Clientbereichsgrenze handelt.

Geschützte Methoden

Name Beschreibung
CMFCColorBar::AdjustLocations Passt die Positionen der Farbschaltflächen im Farbbalken-Steuerelement an.
CMFCColorBar::AllowChangeTextLabels Gibt an, ob sich die Beschriftung von Farbschaltflächen ändern kann.
CMFCColorBar::AllowShowOnList Gibt an, ob das Farbbalken-Steuerelementobjekt während des Anpassungsprozesses in einer Symbolleistenliste angezeigt werden kann.
CMFCColorBar::CalcSize Vom Framework als Teil des Layoutberechnungsprozesses aufgerufen.
CMFCColorBar::CreatePalette Initialisiert eine Palette mit den Farben in einem angegebenen Array von Farben.
CMFCColorBar::GetColorGridSize Berechnet die Anzahl der Zeilen und Spalten im Raster eines Farbbalken-Steuerelements.
CMFCColorBar::GetExtraHeight Berechnet die zusätzliche Höhe, die der aktuelle Farbbalken benötigt, um verschiedene Benutzeroberflächenelemente wie die Schaltfläche "Andere ", Dokumentfarben usw. anzuzeigen.
CMFCColorBar::InitColors Initialisiert ein Array von Farben mit den Farben in einer angegebenen Palette oder der Systemstandardpalette.
CMFCColorBar::OnKey Wird vom Framework aufgerufen, wenn ein Benutzer eine Tastaturtaste drückt.
CMFCColorBar::OnSendCommand Vom Framework aufgerufen, um eine Hierarchie von Popupsteuerelementen zu schließen.
CMFCColorBar::OnUpdateCmdUI Wird vom Framework aufgerufen, um ein Benutzeroberflächenelement eines Farbbalken-Steuerelements zu aktivieren oder zu deaktivieren, bevor das Element angezeigt wird.
CMFCColorBar::OpenColorDialog Öffnet ein Farbdialogfeld.
CMFCColorBar::Rebuild Das Farbbalken-Steuerelement wird vollständig neu gezeichnet.
CMFCColorBar::SelectPalette Legt die logische Palette des angegebenen Gerätekontexts auf die Palette der übergeordneten Schaltfläche des aktuellen Farbbalken-Steuerelements fest.
CMFCColorBar::SetPropList Legt das m_pWndPropList geschützte Datenelement auf den angegebenen Zeiger auf ein Eigenschaftenrastersteuerelement fest.
CMFCColorBar::ShowCommandMessageString Fordert das Rahmenfenster an, das das Farbbalken-Steuerelement besitzt, um die Nachrichtenzeile in der Statusleiste zu aktualisieren.

Geschützte Datenmember

Name Beschreibung
m_bInternal Ein boolesches Feld, das bestimmt, ob Mausereignisse verarbeitet werden. In der Regel werden Mausereignisse verarbeitet, wenn dieses Feld WAHR ist und der Anpassungsmodus FALSE ist.
m_bIsEnabled Ein Boolescher Wert, der angibt, ob ein Steuerelement aktiviert ist.
m_bIsTearOff Ein Boolescher Wert, der angibt, ob das Farbbalken-Steuerelement das Andocken unterstützt.
m_BoxSize Ein CSize-Objekt , das die Größe einer Zelle in einem Farbbalkenraster angibt.
m_bShowDocColorsWhenDocked Ein Boolescher Wert, der angibt, ob Dokumentfarben angezeigt werden sollen, wenn der Farbbalken angedockt ist. Weitere Informationen finden Sie unter CMFCColorBar::SetDocumentColors.
m_bStdColorDlg Ein Boolescher Wert, der angibt, ob das Standardmäßige Systemfarbdialogfeld oder das Dialogfeld CMFCColorDialog angezeigt werden soll. Weitere Informationen finden Sie unter CMFCColorBar::EnableOtherButton.
m_ColorAutomatic EIN COLORREF , das die aktuelle automatische Farbe speichert. Weitere Informationen finden Sie unter CMFCColorBar::EnableOtherButton.
m_ColorNames Ein CMap-Objekt , das einem Satz von RGB-Farben die Namen zuordnet.
m_colors Ein CArray von COLORREF-Werten , die die Farben enthalten, die im Farbbalkensteuerelement angezeigt werden.
m_ColorSelected Ein COLORREF-Wert , der die Farbe ist, die der Benutzer aktuell aus dem Farbbalken-Steuerelement ausgewählt hat.
m_lstDocColors Eine CList von COLORREF-Werten , die die Farben enthalten, die derzeit in einem Dokument verwendet werden.
m_nCommandID Eine nicht signierte ganze Zahl, die die Befehls-ID einer Farbschaltfläche ist.
m_nHorzMargin Eine ganze Zahl, die den horizontalen Rand zwischen den Farbschaltflächen in einem Raster mit Farben darstellt.
m_nHorzOffset Eine ganze Zahl, die den horizontalen Offset zur Mitte der Farbschaltfläche darstellt. Dieser Wert ist wichtig, wenn auf der Schaltfläche zusätzlich zu einer Farbe Text oder ein Bild angezeigt wird.
m_nNumColumns Eine ganze Zahl, die die Anzahl der Spalten in einem Farbbalken-Steuerelementraster mit Farben darstellt.
m_nNumColumnsVert Eine ganze Zahl, die die Anzahl der Spalten in einem vertikal ausgerichteten Raster mit Farben darstellt.
m_nNumRowsHorz Eine ganze Zahl, die die Anzahl der Spalten in einem horizontal ausgerichteten Gitter mit Farben darstellt.
m_nRowHeight Eine ganze Zahl, die die Höhe einer Reihe von Farbschaltflächen in einem Gitter mit Farben darstellt.
m_nVertMargin Eine ganze Zahl, die den vertikalen Rand zwischen den Farbschaltflächen in einem Raster mit Farben darstellt.
m_nVertOffset Eine ganze Zahl, die den vertikalen Offset zur Mitte der Farbschaltfläche darstellt. Dieser Wert ist wichtig, wenn auf der Schaltfläche zusätzlich zu einer Farbe Text oder ein Bild angezeigt wird.
m_Palette Eine CPalette der Farben, die im Farbbalkensteuerelement verwendet werden.
m_pParentBtn Ein Zeiger auf ein CMFCColorButton -Objekt, das das übergeordnete Element der aktuellen Schaltfläche ist. Dieser Wert ist wichtig, wenn sich die Farbschaltfläche in einer Hierarchie von Symbolleistensteuerelementen befindet oder sich in einem Farbeigenschaftenraster-Steuerelement befindet.
m_pParentRibbonBtn Ein Zeiger auf ein CMFCRibbonColorButton -Objekt, das sich im Menüband befindet und die übergeordnete Schaltfläche der aktuellen Schaltfläche ist. Dieser Wert ist wichtig, wenn sich die Farbschaltfläche in einer Hierarchie von Symbolleistensteuerelementen befindet oder sich in einem Farbeigenschaftenraster-Steuerelement befindet.
m_pWndPropList Ein Zeiger auf ein CMFCPropertyGridCtrl -Objekt.
m_strAutoColor Eine CString , die den Text darstellt, der auf der Schaltfläche "Automatisch" angezeigt wird. Weitere Informationen finden Sie unter CMFCColorBar::EnableAutomaticButton.
m_strDocColors Eine CString , die den Text darstellt, der auf der Schaltfläche "Dokumentfarben" angezeigt wird. Weitere Informationen finden Sie unter CMFCColorBar::SetDocumentColors.
m_strOtherColor Eine CString , die den Text darstellt, der auf der anderen Schaltfläche angezeigt wird. Weitere Informationen finden Sie unter CMFCColorBar::EnableOtherButton.

Hinweise

In der Regel erstellen Sie kein CMFCColorBar Objekt direkt. Stattdessen erstellt die CMFCColorMenuButton-Klasse (in Menüs und Symbolleisten verwendet) oder die CMFCColorButton-Klasse das CMFCColorBar Objekt.

Die CMFCColorBar Klasse bietet die folgenden Funktionen:

  • Passt die Liste der Dokumentfarben automatisch an.

  • Speichert und stellt seinen Zustand zusammen mit dem Dokumentzustand wieder her.

  • Verwaltet die Schaltfläche "Automatisch".

  • Verwendet das CMFCColorPickerCtrl-Klassensteuerelement , um eine benutzerdefinierte Farbe auszuwählen.

  • Unterstützt einen "Tear-off"-Zustand (wenn er mithilfe der CMFCColorMenuButton-Klasse erstellt wird).

So integrieren Sie die CMFCColorBar Funktionalität in Ihre Anwendung:

  1. Erstellen Sie eine normale Menüschaltfläche, und weisen Sie sie einer ID zu, z. B. ID_CHAR_COLOR.

  2. Überschreiben Sie in Der Framefensterklasse die CFrameWndEx::OnShowPopupMenuMenu-Methode , und ersetzen Sie die reguläre Menüschaltfläche durch ein CMFCColorMenuButton-Klassenobjekt (durch Aufrufen von CMFCToolBar::ReplaceButton).

  3. Legen Sie alle Formatvorlagen fest, und aktivieren oder deaktivieren Sie die Features des Objekts während der CMFCColorBar CMFCColorMenuButton-Klassenerstellung. Das CMFCColorMenuButton Objekt erstellt das CMFCColorBar Objekt dynamisch, nachdem das Framework die CreatePopupMenu Methode aufgerufen hat.

Wenn der Benutzer auf eine Schaltfläche für ein Farbbalken-Steuerelement klickt, verwendet das Framework das ON_COMMAND Makro, um das übergeordnete Element des Farbbalken-Steuerelements zu benachrichtigen. Im Makro ist der Befehls-ID-Parameter der Wert, den Sie der Schaltfläche für das Farbbalken-Steuerelement in Schritt 1 zugewiesen haben (ID_CHAR_COLOR in diesem Beispiel). Weitere Informationen finden Sie unter den KLASSEN CMFCColorMenuButton Class, CMFCColorButton Class, CMFCColorPickerCtrl Class, CFrameWndEx Class und CMFCToolBar Class .

Beispiel

Im folgenden Beispiel wird das Konfigurieren eines Farbbalkens mithilfe verschiedener Methoden in der CMFCColorBar Klasse veranschaulicht. Mit den Methoden werden die horizontalen und vertikalen Seitenränder festgelegt, die andere Schaltfläche aktiviert, ein Farbbalken-Steuerelementfenster erstellt und die aktuell ausgewählte Farbe festgelegt. Dieses Beispiel ist Teil des Beispiels "Neue Steuerelemente".

CMFCColorBar m_wndColorBar;

// set the margins
m_wndColorBar.SetHorzMargin(0);
m_wndColorBar.SetVertMargin(0);
// enable the display of a dialog box that
// lets the user select more colors
m_wndColorBar.EnableOtherButton(_T("Other..."));
// create a color bar control window
m_wndColorBar.CreateControl(this, rectColorBar, IDC_COLORBAR, 5 /* columns */);
// set the currently selected color
m_wndColorBar.SetColor(RGB(255, 0, 0));

Vererbungshierarchie

CObject

CCmdTarget

CWnd

CBasePane

CPane

CMFCBaseToolBar

CMFCToolBar

CMFCPopupMenuBar

CMFCColorBar

Anforderungen

Kopfzeile: afxcolorbar.h

CMFCColorBar::AdjustLocations

Passt die Positionen der Farbschaltflächen im Farbbalken-Steuerelement an.

virtual void AdjustLocations();

Hinweise

Diese Methode wird vom Framework während WM_SIZE Nachrichtenverarbeitung aufgerufen.

CMFCColorBar::AllowChangeTextLabels

Gibt an, ob sich die Beschriftung von Farbschaltflächen ändern kann.

virtual BOOL AllowChangeTextLabels() const;

Rückgabewert

Immer FALSE

Hinweise

Standardmäßig gibt diese Methode immer FALSE zurück, was bedeutet, dass Textbeschriftungen nicht geändert werden können. Überschreiben Sie diese Methode, um das Ändern von Textbeschriftungen zu ermöglichen.

CMFCColorBar::AllowShowOnList

Gibt an, ob das Farbbalken-Steuerelementobjekt während des Anpassungsprozesses in einer Symbolleistenliste angezeigt werden kann.

virtual BOOL AllowShowOnList() const;

Rückgabewert

Immer TRUE.

Hinweise

Standardmäßig gibt diese Methode immer TRUE zurück, was bedeutet, dass das Framework das Farbbalken-Steuerelement während des Anpassungsprozesses anzeigen kann. Überschreiben Sie diese Methode, um ein anderes Verhalten zu implementieren.

CMFCColorBar::CalcSize

Vom Framework als Teil des Layoutberechnungsprozesses aufgerufen.

virtual CSize CalcSize(BOOL bVertDock);

Parameter

bVertDock
[in] TRUE, um anzugeben, dass das Farbbalken-Steuerelement vertikal verankert ist; FALSE, um anzugeben, dass das Farbbalken-Steuerelement horizontal angedockt ist.

Rückgabewert

Die Größe des Arrays von Farbschaltflächen in einem Farbbalken-Steuerelement.

CMFCColorBar::CMFCColorBar

Erstellt ein CMFCColorBar-Objekt.

CMFCColorBar(
    const CArray<COLORREF,COLORREF>& colors,
    COLORREF color,
    LPCTSTR lpszAutoColor,
    LPCTSTR lpszOtherColor,
    LPCTSTR lpszDocColors,
    CList<COLORREF,COLORREF>& lstDocColors,
    int nColumns,
    int nRowsDockHorz,
    int nColDockVert,
    COLORREF colorAutomatic,
    UINT nCommandID,
    CMFCColorButton* pParentBtn);

CMFCColorBar(
    const CArray<COLORREF,COLORREF>& colors,
    COLORREF color,
    LPCTSTR lpszAutoColor,
    LPCTSTR lpszOtherColor,
    LPCTSTR lpszDocColors,
    CList<COLORREF,COLORREF>& lstDocColors,
    int nColumns,
    COLORREF colorAutomatic,
    UINT nCommandID,
    CMFCRibbonColorButton* pParentRibbonBtn);

CMFCColorBar(
    CMFCColorBar& src,
    UINT uiCommandID);

Parameter

Farben
[in] Ein Array von Farben, das vom Framework im Farbbalken-Steuerelement angezeigt wird.

color
[in] Die anfänglich ausgewählte Farbe.

lpszAutoColor
[in] Die Textbezeichnung der automatischen (Standard)-Farbschaltfläche oder NULL.

Die Standardbezeichnung für die automatische Schaltfläche ist "Automatisch".

lpszOtherColor
[in] Die Textbezeichnung der anderen Schaltfläche, die weitere Farbauswahlen oder NULL anzeigt.

Die Standardbezeichnung für die andere Schaltfläche ist "Weitere Farben...".

lpszDocColors
[in] Die Textbezeichnung der Schaltfläche "Dokumentfarben". Die Dokumentfarbenpalette listet alle Farben auf, die das Dokument derzeit verwendet.

lstDocColors
[in] Eine Liste der Farben, die das Dokument derzeit verwendet.

nColumns
[in] Die Anzahl der Spalten, über die das Array von Farben verfügt.

nRowsDockHorz
[in] Die Anzahl der Zeilen, die der Farbbalken hat, wenn er horizontal angedockt wird.

nColDockVert
[in] Die Anzahl der Spalten, die der Farbbalken hat, wenn er vertikal angedockt wird.

colorAutomatic
[in] Die Standardfarbe, die das Framework anwendet, wenn Sie auf die automatische Schaltfläche klicken.

nCommandID
[in] Befehls-ID des Farbleisten-Steuerelements.

pParentBtn
[in] Ein Zeiger auf eine übergeordnete Schaltfläche.

src
[in] Ein vorhandenes CMFCColorBar Objekt, das in das neue CMFCColorBar Objekt kopiert werden soll.

uiCommandID
[in] Die Befehls-ID.

CMFCColorBar::ContextToSize

Berechnet die vertikalen und horizontalen Ränder, die erforderlich sind, um die Schaltflächen im Farbbalken-Steuerelement zu enthalten, und passt die Position dieser Schaltflächen an.

void ContextToSize(
    BOOL bSquareButtons = TRUE,
    BOOL bCenterButtons = TRUE);

Parameter

bSquareButtons
[in] TRUE, um anzugeben, dass die Form der Schaltflächen in einem Farbbalken-Steuerelement quadratisch ist; andernfalls FALSE. Der Standardwert ist TRUE.

bCenterButtons
[in] TRUE, um anzugeben, dass der Inhalt auf der Oberfläche einer Farbleisten-Steuerelementschaltfläche zentriert ist; andernfalls FALSE. Der Standardwert ist TRUE.

Hinweise

CMFCColorBar::Create

Erstellt ein Farbbalken-Steuerelementfenster und fügt es an das CMFCColorBar Objekt an.

virtual BOOL Create(
    CWnd* pParentWnd,
    DWORD dwStyle,
    UINT nID,
    CPalette* pPalette=NULL,
    int nColumns=0,
    int nRowsDockHorz=0,
    int nColDockVert=0);

Parameter

pParentWnd
[in] Zeiger auf das übergeordnete Fenster.

dwStyle
[in] Eine bitweise Kombination (OR) von Fensterformatvorlagen.

Nid
[in] Die Befehls-ID.

pPalette
[in] Zeiger auf eine Palette von Farben. Der -Standardwert ist NULL.

nColumns
[in] Die Anzahl der Spalten im Farbbalken-Steuerelement. Der Standardwert ist 0.

nRowsDockHorz
[in] Die Anzahl der Zeilen im Farbbalken-Steuerelement, wenn sie horizontal angedockt wird. Der Standardwert ist 0.

nColDockVert
[in] Die Anzahl der Spalten im Farbbalken-Steuerelement, wenn sie vertikal angedockt wird. Der Standardwert ist 0.

Rückgabewert

TRUE, wenn diese Methode erfolgreich ist; andernfalls FALSE.

Hinweise

Rufen Sie zum Erstellen eines CMFCColorBar Objekts den Klassenkonstruktor dann diese Methode auf. Die Create Methode erstellt das Windows-Steuerelement und initialisiert eine Liste von Farben.

CMFCColorBar::CreateControl

Erstellt ein Farbbalken-Steuerelementfenster, fügt es an das CMFCColorBar Objekt an und ändert die Größe des Steuerelementfensters so, dass es die angegebene Farbpalette enthält.

virtual BOOL CreateControl(
    CWnd* pParentWnd,
    const CRect& rect,
    UINT nID,
    int nColumns=-1,
    CPalette* pPalette=NULL);

Parameter

pParentWnd
[in] Zeiger auf das übergeordnete Fenster. Lässt keine NULL-Werte zu.

rect
[in] Ein umgebendes Rechteck, das angibt, wo das Farbbalken-Steuerelement gezeichnet werden soll.

Nid
[in] Die Steuerelement-ID.

nColumns
[in] Die ideale Anzahl von Spalten im Farbbalken-Steuerelement. Diese Methode ändert diese Zahl so, dass sie der angegebenen Farbpalette entspricht. Der Standardwert ist -1, was bedeutet, dass dieser Parameter nicht angegeben ist.

pPalette
[in] Zeiger auf eine Palette von Farben oder NULL. Wenn dieser Parameter NULL ist, berechnet diese Methode die Größe des Farbbalken-Steuerelements so, als ob 20 Farben angegeben wurden. Der -Standardwert ist NULL.

Rückgabewert

TRUE, wenn diese Methode erfolgreich ist; andernfalls FALSE.

Hinweise

Diese Methode verwendet die Parameter "rect", "nColumns" und "pPalette ", um die entsprechende Anzahl oder Zeilen und Spalten im Farbbalken-Steuerelement zu berechnen, und ruft dann die CMFCColorBar::Create-Methode auf.

CMFCColorBar::CreatePalette

Initialisiert eine Palette mit den Farben in einem angegebenen Array von Farben.

static BOOL CreatePalette(
    const CArray<COLORREF, COLORREF>& arColors,
    CPalette& palette);

Parameter

arColors
[in] Ein Array von Farben.

Palette
[in] Eine Palette von Farben.

Rückgabewert

TRUE, wenn diese Methode erfolgreich ist; andernfalls FALSE.

CMFCColorBar::EnableAutomaticButton

Blendet die automatische Schaltfläche ein oder aus.

void EnableAutomaticButton(
    LPCTSTR lpszLabel,
    COLORREF colorAutomatic,
    BOOL bEnable=TRUE);

Parameter

lpszLabel
[in] Die Textbezeichnung der automatischen (Standard)-Farbschaltfläche oder NULL.

Die Standardbezeichnung für die automatische Schaltfläche ist "Automatisch".

colorAutomatic
[in] Die Standardfarbe, die das Framework anwendet, wenn Sie auf die automatische Schaltfläche klicken.

bEnable
[in] TRUE, um die automatische Schaltfläche zu aktivieren; FALSE zum Deaktivieren der automatischen Schaltfläche. Der Standardwert ist TRUE.

Hinweise

Die Textbeschriftung der automatischen Schaltfläche wird gelöscht, wenn der parameter lpszLabel NULL ist oder der bEnable-Parameter FALSE ist.

CMFCColorBar::EnableOtherButton

Aktiviert oder deaktiviert die Anzeige eines Dialogfelds, mit dem der Benutzer weitere Farben auswählen kann.

void EnableOtherButton(
    LPCTSTR lpszLabel,
    BOOL bAltColorDlg=TRUE,
    BOOL bEnable=TRUE);

Parameter

lpszLabel
[in] Die Textbezeichnung der anderen Schaltfläche, die weitere Farbauswahlen oder NULL anzeigt.

Die Standardbezeichnung für diese Schaltfläche ist "Weitere Farben...".

bAltColorDlg
[in] TRUE, um das Dialogfeld CMFCColorDialog anzuzeigen; FALSE zum Anzeigen des standardmäßigen Dialogfelds "CColorDialog ". Der Standardwert ist TRUE.

bEnable
[in] TRUE, um die Schaltfläche zu aktivieren; FALSE, um die Schaltfläche zu deaktivieren. Der Standardwert ist TRUE.

CMFCColorBar::GetColor

Ruft die aktuell ausgewählte Farbe ab.

COLORREF GetColor() const;

Rückgabewert

Die aktuell ausgewählte Farbe.

CMFCColorBar::GetColorGridSize

Berechnet die Anzahl der Zeilen und Spalten im Raster eines Farbbalken-Steuerelements.

CSize GetColorGridSize(BOOL bVertDock) const;

Parameter

bVertDock
[in] TRUE, um die Berechnung für ein vertikal verankertes Farbbalken-Steuerelement auszuführen; führen Sie andernfalls die Berechnung für ein horizontal verankertes Steuerelement aus.

Rückgabewert

Ein CSize-Objekt, dessen cx Komponente die Anzahl der Spalten enthält und deren cy Komponente die Anzahl der Zeilen enthält.

CMFCColorBar::GetCommandID

Ruft die Befehls-ID des aktuellen Farbbalken-Steuerelements ab.

UINT GetCommandID() const;

Rückgabewert

Eine Befehls-ID.

Hinweise

Wenn der Benutzer eine neue Farbe auswählt, sendet das Framework die Befehls-ID in einer WM_COMMAND Nachricht, um das übergeordnete CMFCColorBar Objekt zu benachrichtigen.

CMFCColorBar::GetExtraHeight

Berechnet die zusätzliche Höhe, die der aktuelle Farbbalken benötigt, um verschiedene Benutzeroberflächenelemente anzuzeigen, z. B. die Schaltfläche "Sonstige " oder Dokumentfarben.

int GetExtraHeight(int nNumColumns) const;

Parameter

nNumColumns
[in] Wenn das Farbbalken-Steuerelement Dokumentfarben enthält, wird die Anzahl der Spalten, die im Raster der Dokumentfarben angezeigt werden sollen. Andernfalls wird dieser Wert nicht verwendet.

Rückgabewert

Die berechnete zusätzliche Höhe, die erforderlich ist.

CMFCColorBar::GetHighlightedColor

Ruft die Farbe ab, die angibt, dass eine Farbschaltfläche den Fokus hat; das heißt, die Schaltfläche ist heiß.

COLORREF GetHighlightedColor() const;

Rückgabewert

Ein RGB-Wert.

Hinweise

CMFCColorBar::GetHorzMargin

Ruft den horizontalen Rand ab, bei dem es sich um den Abstand zwischen der linken oder rechten Farbzelle und der Clientbereichsgrenze handelt.

int GetHorzMargin();

Rückgabewert

Der horizontale Rand.

CMFCColorBar::GetVertMargin

Ruft den vertikalen Rand ab, bei dem es sich um den Abstand zwischen der oberen oder unteren Farbzelle und der Clientbereichsgrenze handelt.

int GetVertMargin() const;

Rückgabewert

Der vertikale Rand.

CMFCColorBar::InitColors

Initialisiert ein Array von Farben mit den Farben in einer angegebenen Palette oder mit der Systemstandardpalette.

static int InitColors(
    CPalette* pPalette,
    CArray<COLORREF, COLORREF>& arColors);

Parameter

pPalette
[in] Ein Zeiger auf ein Palettenobjekt oder NULL. Wenn dieser Parameter NULL ist, verwendet diese Methode die Standardpalette des Betriebssystems.

arColors
[in] Ein Array von Farben.

Rückgabewert

Die Anzahl der Elemente im Array von Farben.

CMFCColorBar::IsTearOff

Gibt an, ob der aktuelle Farbbalken andockbar ist.

BOOL IsTearOff() const;

Rückgabewert

TRUE, wenn das aktuelle Farbbalken-Steuerelement andockbar ist; andernfalls FALSE.

Hinweise

Wenn das Farbbalken-Steuerelement andockbar ist, kann es an einer anderen Position aus einer Steuerleiste abgerissen und angedockt werden.

CMFCColorBar::OnKey

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

virtual BOOL OnKey(UINT nChar);

Parameter

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

Rückgabewert

TRUE, wenn diese Methode den angegebenen Schlüssel verarbeitet; andernfalls FALSE.

CMFCColorBar::OnSendCommand

Vom Framework aufgerufen, um eine Hierarchie von Popupsteuerelementen zu schließen.

virtual BOOL OnSendCommand(const CMFCToolBarButton* pButton);

Parameter

pButton
[in] Zeigen Sie auf ein Steuerelement, das sich auf einer Symbolleiste befindet.

Rückgabewert

TRUE, wenn diese Methode erfolgreich ist; andernfalls FALSE.

CMFCColorBar::OnUpdateCmdUI

Wird vom Framework aufgerufen, um ein Benutzeroberflächenelement eines Farbbalken-Steuerelements zu aktivieren oder zu deaktivieren, bevor das Element angezeigt wird.

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

Parameter

pTarget
[in] Zeigen Sie auf ein Fenster, das ein zu aktualisierende Benutzeroberflächenelement enthält.

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

Hinweise

Wenn ein Benutzer Ihrer Anwendung auf ein Benutzeroberflächenelement klickt, muss das Element wissen, ob es als aktiviert oder deaktiviert angezeigt werden soll. Das Ziel der Befehlsmeldung stellt diese Informationen bereit, indem ein ON_UPDATE_COMMAND_UI Befehlshandler implementiert wird. Verwenden Sie diese Methode, um den Befehl zu verarbeiten. Weitere Informationen finden Sie unter CCmdUI-Klasse.

CMFCColorBar::OpenColorDialog

Öffnet ein Farbdialogfeld.

virtual BOOL OpenColorDialog(
    const COLORREF colorDefault,
    COLORREF& colorRes);

Parameter

colorDefault
[in] Die Farbe, die standardmäßig ausgewählt ist, wenn das Farbdialogfeld geöffnet wird.

colorRes
[out] Die Farbe, die ein Benutzer ausgewählt hat.

Rückgabewert

TRUE, wenn der Benutzer eine Farbe ausgewählt hat; FALSE, wenn der Benutzer das Dialogfeld "Farbe" abgebrochen hat.

Hinweise

CMFCColorBar::Rebuild

Das Farbbalken-Steuerelement wird vollständig neu gezeichnet.

virtual void Rebuild();

CMFCColorBar::SelectPalette

Legt die logische Palette des angegebenen Gerätekontexts auf die Palette der übergeordneten Schaltfläche des aktuellen Farbbalken-Steuerelements fest.

CPalette* SelectPalette(CDC* pDC);

Parameter

pDC
[in] Zeigen Sie auf den Gerätekontext der übergeordneten Schaltfläche des aktuellen Farbbalken-Steuerelements.

Rückgabewert

Zeiger auf die Palette, die durch die Palette der übergeordneten Schaltfläche des aktuellen Farbbalken-Steuerelements ersetzt wird.

CMFCColorBar::SetColor

Legt die aktuell ausgewählte Farbe fest.

void SetColor(COLORREF color);

Parameter

color
[in] Ein RGB-Farbwert.

CMFCColorBar::SetColorName

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

static void 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

Diese Methode ändert den Namen der angegebenen Farbe in allen CMFCColorBar Objekten in Ihrer Anwendung.

CMFCColorBar::SetCommandID

Legt eine neue Befehls-ID für ein Farbbalken-Steuerelement fest.

void SetCommandID(UINT nCommandID);

Parameter

nCommandID
[in] Eine Befehls-ID.

Hinweise

Rufen Sie diese Methode auf, um die Befehls-ID eines Farbbalken-Steuerelements zu ändern und das übergeordnete Fenster des Steuerelements zu benachrichtigen, dass sich die ID geändert hat.

CMFCColorBar::SetDocumentColors

Legt die Liste der Farben fest, die im aktuellen Dokument verwendet werden.

void SetDocumentColors(
    LPCTSTR lpszCaption,
    CList<COLORREF,COLORREF>& lstDocColors,
    BOOL bShowWhenDocked=FALSE);

Parameter

lpszCaption
[in] Eine Beschriftung, die angezeigt wird, wenn das Farbleisten-Steuerelement nicht angedockt ist.

lstDocColors
[in] Eine Liste der Farben, die die aktuellen Dokumentfarben ersetzen.

bShowWhenDocked
[in] TRUE, um Dokumentfarben anzuzeigen, wenn das Farbbalken-Steuerelement angedockt ist. andernfalls FALSE. Der Standardwert ist FALSCH.

Hinweise

Dokumentfarben sind die Farben, die derzeit in einem Dokument verwendet werden. Das Framework verwaltet automatisch eine Liste von Dokumentfarben, aber Sie können diese Methode verwenden, um die Liste zu ändern.

CMFCColorBar::SetHorzMargin

Legt den horizontalen Rand fest, bei dem es sich um den Abstand zwischen der linken oder rechten Farbzelle und der Grenze des Clientbereichs handelt.

void SetHorzMargin(int nHorzMargin);

Parameter

nHorzMargin
[in] Der horizontale Rand in Pixel.

Hinweise

Standardmäßig legt der CMFCColorBar::CMFCColorBar-Konstruktor den horizontalen Rand auf 4 Pixel fest.

CMFCColorBar::SetPropList

Legt das m_pWndPropList geschützte Datenelement auf den angegebenen Zeiger auf ein Eigenschaftenrastersteuerelement fest.

void SetPropList(CMFCPropertyGridCtrl* pWndList);

Parameter

pWndList
[in] Zeiger auf Eigenschaftenraster-Steuerelementobjekt.

CMFCColorBar::SetVertMargin

Legt den vertikalen Rand fest, bei dem es sich um den Abstand zwischen der oberen oder unteren Farbzelle und der Clientbereichsgrenze handelt.

void SetVertMargin(int nVertMargin);

Parameter

nVertMargin
[in] Der vertikale Rand in Pixel.

Hinweise

Standardmäßig legt der CMFCColorBar::CMFCColorBar-Konstruktor den vertikalen Rand auf 4 Pixel fest.

CMFCColorBar::ShowCommandMessageString

Fordert das Rahmenfenster an, das das Farbbalken-Steuerelement besitzt, um die Nachrichtenzeile in der Statusleiste zu aktualisieren.

virtual void ShowCommandMessageString(UINT uiCmdId);

Parameter

uiCmdId
[in] Eine Befehls-ID. (Dieser Parameter wird ignoriert.)

Hinweise

Diese Methode sendet die WM_SETMESSAGESTRING Nachricht an den Besitzer des Farbbalken-Steuerelements.

Siehe auch

Hierarchiediagramm
Klassen