CMFCColorBar クラス

CMFCColorBar クラスは、ドキュメントまたはアプリケーションの色を選択できるドッキング コントロール バーを表します。

構文

class CMFCColorBar : public CMFCPopupMenuBar

メンバー

保護されたコンストラクター

名前 説明
CMFCColorBar::CMFCColorBar CMFCColorBar オブジェクトを構築します。

パブリック メソッド

名前 説明
CMFCColorBar::ContextToSize カラー バー コントロールのボタンを含めるために必要な垂直方向と水平方向の余白を計算し、それらのボタンの位置を調整します。
CMFCColorBar::CreateControl カラー バー コントロール ウィンドウを作成し、 CMFCColorBar オブジェクトにアタッチし、指定した色パレットを含むようにコントロールのサイズを変更します。
CMFCColorBar::Create カラー バー コントロール ウィンドウを作成し、 CMFCColorBar オブジェクトにアタッチします。
CMFCColorBar::EnableAutomaticButton 自動ボタンを表示または非表示にします。
CMFCColorBar::EnableOtherButton ユーザーがより多くの色を選択できるようにするダイアログ ボックスの表示を有効または無効にします。
CMFCColorBar::GetColor 現在選択されている色を取得します。
CMFCColorBar::GetCommandID 現在のカラー バー コントロールのコマンド ID を取得します。
CMFCColorBar::GetHighlightedColor カラー ボタンにフォーカスがあることを示す色を取得します。つまり、ボタンは hot です。
CMFCColorBar::GetHorzMargin 左右の色のセルとクライアント領域の境界の間のスペースである水平方向の余白を取得します。
CMFCColorBar::GetVertMargin 垂直方向の余白を取得します。これは、上または下の色のセルとクライアント領域の境界の間のスペースです。
CMFCColorBar::IsTearOff 現在のカラー バーがドッキング可能かどうかを示します。
CMFCColorBar::SetColor 現在選択されている色を設定します。
CMFCColorBar::SetColorName 指定した色の新しい名前を設定します。
CMFCColorBar::SetCommandID カラー バー コントロールの新しいコマンド ID を設定します。
CMFCColorBar::SetDocumentColors 現在の文書で使用されている色の一覧を設定します。
CMFCColorBar::SetHorzMargin 左右の色のセルとクライアント領域の境界の間のスペースである水平方向の余白を設定します。
CMFCColorBar::SetVertMargin 垂直方向の余白を設定します。これは、上または下の色のセルとクライアント領域の境界の間のスペースです。

保護メソッド

名前 説明
CMFCColorBar::AdjustLocations カラー バー コントロールのカラー ボタンの位置を調整します。
CMFCColorBar::AllowChangeTextLabels 色ボタンのテキスト ラベルを変更できるかどうかを示します。
CMFCColorBar::AllowShowOnList カスタマイズ 処理中に、カラー バー コントロール オブジェクトをツール バーの一覧に表示できるかどうかを示します。
CMFCColorBar::CalcSize レイアウト計算プロセスの一部としてフレームワークによって呼び出されます。
CMFCColorBar::CreatePalette 指定した色の配列内の色を使用してパレットを初期化します。
CMFCColorBar::GetColorGridSize カラー バー コントロールのグリッド内の行と列の数を計算します。
CMFCColorBar::GetExtraHeight Other ボタン、ドキュメントの色など、その他のユーザー インターフェイス要素を表示するために現在のカラー バーに必要な追加の高さを計算します。
CMFCColorBar::InitColors 指定したパレットまたはシステムの既定のパレットの色を使用して、色の配列を初期化します。
CMFCColorBar::OnKey ユーザーがキーボード ボタンを押したときにフレームワークによって呼び出されます。
CMFCColorBar::OnSendCommand ポップアップ コントロールの階層を閉じるには、フレームワークによって呼び出されます。
CMFCColorBar::OnUpdateCmdUI 項目が表示される前に、カラー バー コントロールのユーザー インターフェイス項目を有効または無効にするためにフレームワークによって呼び出されます。
CMFCColorBar::OpenColorDialog [色] ダイアログ ボックスを開きます。
CMFCColorBar::Rebuild カラー バー コントロールを完全に再描画します。
CMFCColorBar::SelectPalette 指定したデバイス コンテキストの論理パレットを、現在のカラー バー コントロールの親ボタンのパレットに設定します。
CMFCColorBar::SetPropList 保護 m_pWndPropList データ メンバーを、プロパティ グリッド コントロールへの指定されたポインターに設定します。
CMFCColorBar::ShowCommandMessageString ステータス バーのメッセージ行を更新するために、カラー バー コントロールを所有するフレーム ウィンドウを要求します。

プロテクト データ メンバー

名前 説明
m_bInternal マウス イベントが処理されるかどうかを決定するブール型フィールド。 通常、マウス イベントは、このフィールドが TRUE で、カスタマイズ モードが FALSE の場合に処理されます。
m_bIsEnabled コントロールが有効かどうかを示すブール値。
m_bIsTearOff カラー バー コントロールがドッキングをサポートしているかどうかを示すブール値。
m_BoxSize カラー バー グリッド内のセルのサイズを指定する CSize オブジェクト。
m_bShowDocColorsWhenDocked カラー バーがドッキングされたときにドキュメントの色を表示するかどうかを示すブール値。 詳細については、「 CMFCColorBar::SetDocumentColors を参照してください。
m_bStdColorDlg 標準のシステム カラー ダイアログ ボックスまたは CMFCColorDialog ダイアログ ボックスを表示するかどうかを示すブール値。 詳細については、「 CMFCColorBar::EnableOtherButton」を参照してください。
m_ColorAutomatic 現在の自動色を格納する COLORREF 。 詳細については、「 CMFCColorBar::EnableOtherButton」を参照してください。
m_ColorNames RGB 色のセットを名前に関連付ける CMap オブジェクト。
m_colors カラー バー コントロールに表示される色を含むCOLORREF 値のCArray
m_ColorSelected COLORREF ユーザーがカラー バー コントロールから現在選択している色を示す値です。
m_lstDocColors ドキュメントで現在使用されている色を含む COLORREF 値のCList
m_nCommandID カラー ボタンのコマンド ID である符号なし整数。
m_nHorzMargin 色のグリッド内の色ボタン間の水平方向の余白を表す整数。
m_nHorzOffset カラー ボタンの中心への水平方向のオフセットを表す整数。 この値は、ボタンに色に加えてテキストまたは画像が表示される場合に重要です。
m_nNumColumns カラー バーコントロールの色グリッド内の列数を表す整数。
m_nNumColumnsVert 垂直方向の色のグリッド内の列の数を表す整数。
m_nNumRowsHorz 水平方向の色のグリッド内の列の数を表す整数。
m_nRowHeight 色のグリッド内の色ボタンの行の高さを表す整数。
m_nVertMargin 色のグリッド内の色ボタン間の垂直方向の余白を表す整数。
m_nVertOffset カラー ボタンの中心への垂直方向のオフセットを表す整数。 この値は、ボタンに色に加えてテキストまたは画像が表示される場合に重要です。
m_Palette カラー バー コントロールで使用される色の CPalette
m_pParentBtn 現在のボタンの親である CMFCColorButton オブジェクトへのポインター。 この値は、カラー ボタンがツール バー コントロールの階層内にある場合、またはカラー プロパティ グリッド コントロールにある場合に重要です。
m_pParentRibbonBtn リボン上にあり、現在のボタンの親ボタンである CMFCRibbonColorButton オブジェクトへのポインター。 この値は、カラー ボタンがツール バー コントロールの階層内にある場合、またはカラー プロパティ グリッド コントロールにある場合に重要です。
m_pWndPropList CMFCPropertyGridCtrl オブジェクトへのポインター。
m_strAutoColor CString Automatic ボタンに表示されるテキストです。 詳細については、「 CMFCColorBar::EnableAutomaticButton を参照してください。
m_strDocColors CString ドキュメントの色ボタンに表示されるテキストです。 詳細については、「 CMFCColorBar::SetDocumentColors を参照してください。
m_strOtherColor CString その他のボタンに表示されるテキスト。 詳細については、「 CMFCColorBar::EnableOtherButton」を参照してください。

解説

通常、 CMFCColorBar オブジェクトは直接作成しません。 代わりに、 CMFCColorMenuButton クラス (メニューとツール バーで使用) または CMFCColorButton クラス によって CMFCColorBar オブジェクトが作成されます。

CMFCColorBar クラスには、次の機能があります。

CMFCColorBar機能をアプリケーションに組み込むには、

  1. 通常のメニュー ボタンを作成し、ID_CHAR_COLORなどの ID を割り当てます。

  2. フレーム ウィンドウ クラスで、 CFrameWndEx::OnShowPopupMenu メソッドをオーバーライドし、通常のメニュー ボタンを CMFCColorMenuButton Class オブジェクトに置き換えます ( CMFCToolBar::ReplaceButton を呼び出します)。

  3. CMFCColorMenuButton クラス作成時に、すべてのスタイルを設定し、CMFCColorBar オブジェクトの機能を有効または無効にします。 CMFCColorMenuButton オブジェクトは、フレームワークが CreatePopupMenu メソッドを呼び出した後、CMFCColorBar オブジェクトを動的に作成します。

ユーザーがカラー バー コントロール ボタンをクリックすると、フレームワークは ON_COMMAND マクロを使用して、カラー バー コントロールの親に通知します。 マクロのコマンド ID パラメーターは、手順 1 でカラー バー コントロール ボタンに割り当てた値です (この例ではID_CHAR_COLOR)。 詳細については、 CMFCColorMenuButton クラスCMFCColorButton クラスCMFCColorPickerCtrl クラスCFrameWndEx クラス、および CMFCToolBar クラス クラスを参照してください。

次の例では、 CMFCColorBar クラスのさまざまなメソッドを使用してカラー バーを構成する方法を示します。 このメソッドでは、水平方向と垂直方向の余白を設定し、もう一方のボタンを有効にして、カラー バー コントロール ウィンドウを作成し、現在選択されている色を設定します。 この例は、 New Controls サンプルの一部です。

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));

継承階層

CObject

CCmdTarget

CWnd

CBasePane

CPane

CMFCBaseToolBar

CMFCToolBar

CMFCPopupMenuBar

CMFCColorBar

要件

Header: afxcolorbar.h

CMFCColorBar::AdjustLocations

カラー バー コントロールのカラー ボタンの位置を調整します。

virtual void AdjustLocations();

解説

このメソッドは、メッセージ処理中にフレームワークWM_SIZE呼び出されます。

CMFCColorBar::AllowChangeTextLabels

色ボタンのテキスト ラベルを変更できるかどうかを示します。

virtual BOOL AllowChangeTextLabels() const;

戻り値

常に FALSE です。

解説

既定では、このメソッドは常に FALSE を返します。これは、テキスト ラベルを変更できないことを意味します。 テキスト ラベルの変更を有効にするには、このメソッドをオーバーライドします。

CMFCColorBar::AllowShowOnList

カスタマイズ 処理中に、カラー バー コントロール オブジェクトをツール バーの一覧に表示できるかどうかを示します。

virtual BOOL AllowShowOnList() const;

戻り値

常に TRUE。

解説

既定では、このメソッドは常に TRUE を返します。つまり、フレームワークはカスタマイズ プロセス中にカラー バー コントロールを表示できます。 別の動作を実装するには、このメソッドをオーバーライドします。

CMFCColorBar::CalcSize

レイアウト計算プロセスの一部としてフレームワークによって呼び出されます。

virtual CSize CalcSize(BOOL bVertDock);

パラメーター

bVertDock
[in]色バー コントロールを垂直方向にドッキングすることを指定する場合は TRUE。カラー バー コントロールを水平方向にドッキングすることを指定する場合は FALSE。

戻り値

カラー バー コントロール内のカラー ボタンの配列のサイズ。

CMFCColorBar::CMFCColorBar

CMFCColorBar オブジェクトを構築します。

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);

パラメーター


[in]フレームワークがカラー バー コントロールに表示する色の配列。

color
[in]最初に選択した色。

lpszAutoColor
[in] 自動 (既定) の色ボタンのテキスト ラベル、または NULL。

自動ボタンの標準ラベルは Automatic です。

lpszOtherColor
[in]その他の ボタンのテキスト ラベル。色の選択肢が増えるか、NULL が表示されます。

もう一方のボタンの標準ラベルは More Colors... です。

lpszDocColors
[in]ドキュメントの色ボタンのテキスト ラベル。 ドキュメントの色パレットには、ドキュメントで現在使用されているすべての色が一覧表示されます。

lstDocColors
[in]ドキュメントで現在使用されている色の一覧。

nColumns
[in]色の配列に含まれる列の数。

nRowsDockHorz
[in]カラー バーが水平方向にドッキングされたときの行数。

nColDockVert
[in]カラー バーが垂直方向にドッキングされたときに持つ列の数。

colorAutomatic
[in]自動ボタンをクリックしたときにフレームワークが適用する既定の色。

nCommandID
[in]カラー バー コントロールのコマンド ID。

pParentBtn
[in]親ボタンへのポインター。

src
[in]新しいCMFCColorBar オブジェクトにコピーする既存のCMFCColorBar オブジェクト。

uiCommandID
[入力] コマンド ID。

CMFCColorBar::ContextToSize

カラー バー コントロールのボタンを含めるために必要な垂直方向と水平方向の余白を計算し、それらのボタンの位置を調整します。

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

パラメーター

bSquareButtons
[in]TRUE は、カラー バー コントロールのボタンの図形が正方形であることを指定します。それ以外の場合は FALSE。 既定値は TRUE です。

bCenterButtons
[in]TRUE は、カラー バー コントロール ボタンの面のコンテンツが中央に配置されることを指定します。それ以外の場合は FALSE。 既定値は TRUE です。

解説

CMFCColorBar::Create

カラー バー コントロール ウィンドウを作成し、 CMFCColorBar オブジェクトにアタッチします。

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

パラメーター

pParentWnd
[in]親ウィンドウへのポインター。

dwStyle
[in] ウィンドウ スタイルのビットごとの組み合わせ (OR

nID
[入力] コマンド ID。

pPalette
[in]色のパレットへのポインター。 の既定値は NULL です。

nColumns
[in]カラー バー コントロール内の列の数。 既定値は 0 です。

nRowsDockHorz
[in]カラー バー コントロールが水平方向にドッキングされたときの行数。 既定値は 0 です。

nColDockVert
[in]カラー バー コントロールが垂直方向にドッキングされたときの列の数。 既定値は 0 です。

戻り値

このメソッドが成功した場合は TRUE。それ以外の場合は FALSE。

解説

CMFCColorBar オブジェクトを構築するには、クラス コンストラクターを呼び出し、次にこのメソッドを呼び出します。 Create メソッドは、Windows コントロールを作成し、色の一覧を初期化します。

CMFCColorBar::CreateControl

カラー バー コントロール ウィンドウを作成し、 CMFCColorBar オブジェクトにアタッチし、コントロール ウィンドウのサイズを変更して、指定した色のパレットを含めます。

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

パラメーター

pParentWnd
[in]親ウィンドウへのポインター。 Nll は指定できません。

rect
[in]カラー バー コントロールを描画する場所を指定する外接する四角形。

nID
[入力] コントロール ID。

nColumns
[in]カラー バー コントロールの理想的な列数。 このメソッドは、指定した色のパレットに合わせてその数を変更します。 既定値は -1 です。これは、このパラメーターが指定されていないことを意味します。

pPalette
[in]色のパレット (NULL) へのポインター。 このパラメーターが NULL の場合、このメソッドは 20 色が指定されたかのようにカラー バー コントロールのサイズを計算します。 の既定値は NULL です。

戻り値

このメソッドが成功した場合は TRUE。それ以外の場合は FALSE。

解説

このメソッドは、 rectnColumns、および pPalette パラメーターを使用して、カラー バー コントロール内の適切な数または行と列を計算し、 CMFCColorBar::Create メソッドを呼び出します。

CMFCColorBar::CreatePalette

指定した色の配列内の色を使用してパレットを初期化します。

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

パラメーター

arColors
[in]色の配列。

パレット
[in]色のパレット。

戻り値

このメソッドが成功した場合は TRUE。それ以外の場合は FALSE。

CMFCColorBar::EnableAutomaticButton

自動ボタンを表示または非表示にします。

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

パラメーター

lpszLabel
[in] 自動 (既定) の色ボタンのテキスト ラベル、または NULL。

自動ボタンの標準ラベルは Automatic です。

colorAutomatic
[in]自動ボタンをクリックしたときにフレームワークが適用する既定の色。

bEnable
[in]自動ボタンを有効にする場合は TRUE。自動ボタンを無効にする場合は FALSE。 既定値は TRUE です。

解説

lpszLabel パラメーターが NULL または bEnable パラメーターが FALSE の場合、自動ボタンのテキスト ラベルは削除されます。

CMFCColorBar::EnableOtherButton

ユーザーがより多くの色を選択できるようにするダイアログ ボックスの表示を有効または無効にします。

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

パラメーター

lpszLabel
[in]その他の ボタンのテキスト ラベル。色の選択肢が増えるか、NULL が表示されます。

このボタンの標準ラベルは More Colors... です。

bAltColorDlg
[in]TRUE を指定すると、 CMFCColorDialog ダイアログ ボックスが表示されます。標準の CColorDialog ダイアログ ボックスを表示する場合は FALSE。 既定値は TRUE です。

bEnable
[in]ボタンを有効にする場合は TRUE。ボタンを無効にする場合は FALSE。 既定値は TRUE です。

CMFCColorBar::GetColor

現在選択されている色を取得します。

COLORREF GetColor() const;

戻り値

現在選択されている色。

CMFCColorBar::GetColorGridSize

カラー バー コントロールのグリッド内の行と列の数を計算します。

CSize GetColorGridSize(BOOL bVertDock) const;

パラメーター

bVertDock
[in]垂直方向にドッキングされたカラー バー コントロールの計算を実行する場合は TRUE。それ以外の場合は、水平方向にドッキングされたコントロールの計算を実行します。

戻り値

cx コンポーネントに列の数が含まれており、cy コンポーネントに行数が含まれるCSize オブジェクト。

CMFCColorBar::GetCommandID

現在のカラー バー コントロールのコマンド ID を取得します。

UINT GetCommandID() const;

戻り値

コマンド ID。

解説

ユーザーが新しい色を選択すると、フレームワークはコマンド ID を WM_COMMAND メッセージに送信して、 CMFCColorBar オブジェクトの親に通知します。

CMFCColorBar::GetExtraHeight

Other ボタンやドキュメントの色など、その他のユーザー インターフェイス要素を表示するために現在のカラー バーに必要な追加の高さを計算します。

int GetExtraHeight(int nNumColumns) const;

パラメーター

nNumColumns
[in]カラー バー コントロールにドキュメントの色が含まれている場合は、ドキュメントの色のグリッドに表示する列の数。 それ以外の場合、この値は使用されません。

戻り値

計算された追加の高さが必要です。

CMFCColorBar::GetHighlightedColor

カラー ボタンにフォーカスがあることを示す色を取得します。つまり、ボタンは hot です。

COLORREF GetHighlightedColor() const;

戻り値

RGB 値。

解説

CMFCColorBar::GetHorzMargin

左右の色のセルとクライアント領域の境界の間のスペースである水平方向の余白を取得します。

int GetHorzMargin();

戻り値

水平方向の余白。

CMFCColorBar::GetVertMargin

垂直方向の余白を取得します。これは、上または下の色のセルとクライアント領域の境界の間のスペースです。

int GetVertMargin() const;

戻り値

垂直方向の余白。

CMFCColorBar::InitColors

指定したパレットの色またはシステムの既定のパレットを使用して、色の配列を初期化します。

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

パラメーター

pPalette
[in]パレット オブジェクトへのポインター、または NULL。 このパラメーターが NULL の場合、このメソッドはオペレーティング システムの既定のパレットを使用します。

arColors
[in]色の配列。

戻り値

色の配列内の要素の数。

CMFCColorBar::IsTearOff

現在のカラー バーがドッキング可能かどうかを示します。

BOOL IsTearOff() const;

戻り値

現在のカラー バー コントロールがドッキング可能な場合は TRUE。それ以外の場合は FALSE。

解説

カラー バー コントロールがドッキング可能な場合は、コントロール バーを引き裂いて別の場所にドッキングできます。

CMFCColorBar::OnKey

ユーザーがキーボード ボタンを押したときにフレームワークによって呼び出されます。

virtual BOOL OnKey(UINT nChar);

パラメーター

nChar
[in]ユーザーが押したキーの仮想キー コード。

戻り値

このメソッドが指定したキーを処理する場合は TRUE。それ以外の場合は FALSE。

CMFCColorBar::OnSendCommand

ポップアップ コントロールの階層を閉じるには、フレームワークによって呼び出されます。

virtual BOOL OnSendCommand(const CMFCToolBarButton* pButton);

パラメーター

pButton
[in]ツール バーに存在するコントロールへのポインター。

戻り値

このメソッドが成功した場合は TRUE。それ以外の場合は FALSE。

CMFCColorBar::OnUpdateCmdUI

項目が表示される前に、カラー バー コントロールのユーザー インターフェイス項目を有効または無効にするためにフレームワークによって呼び出されます。

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

パラメーター

pTarget
[in]更新するユーザー インターフェイス項目を含むウィンドウへのポインター。

bDisableIfNoHndler
[in]メッセージ マップでハンドラーが定義されていない場合にユーザー インターフェイス項目を無効にする場合は TRUE。それ以外の場合は FALSE。

解説

アプリケーションのユーザーがユーザー インターフェイス項目をクリックすると、項目は有効または無効として表示される必要があるかどうかを認識する必要があります。 コマンド メッセージのターゲットは、ON_UPDATE_COMMAND_UIコマンド ハンドラーを実装することによってこの情報を提供します。 このメソッドは、コマンドの処理に役立ちます。 詳細については、「 CCmdUI クラス」を参照してください。

CMFCColorBar::OpenColorDialog

[色] ダイアログ ボックスを開きます。

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

パラメーター

colorDefault
[in]色ダイアログ ボックスが開いたときに既定で選択される色。

colorRes
[out]ユーザーが選択した色。

戻り値

ユーザーが色を選択した場合は TRUE。ユーザーが [色] ダイアログ ボックスを取り消した場合は FALSE。

解説

CMFCColorBar::Rebuild

カラー バー コントロールを完全に再描画します。

virtual void Rebuild();

CMFCColorBar::SelectPalette

指定したデバイス コンテキストの論理パレットを、現在のカラー バー コントロールの親ボタンのパレットに設定します。

CPalette* SelectPalette(CDC* pDC);

パラメーター

pDC
[in]現在のカラー バー コントロールの親ボタンのデバイス コンテキストへのポインター。

戻り値

現在のカラー バー コントロールの親ボタンのパレットに置き換えられるパレットへのポインター。

CMFCColorBar::SetColor

現在選択されている色を設定します。

void SetColor(COLORREF color);

パラメーター

color
[in]RGB カラー値。

CMFCColorBar::SetColorName

指定した色の新しい名前を設定します。

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

パラメーター

color
[in]色の RGB 値。

strName
[in]指定した色の新しい名前。

解説

このメソッドは、アプリケーション内のすべての CMFCColorBar オブジェクトの指定された色の名前を変更します。

CMFCColorBar::SetCommandID

カラー バー コントロールの新しいコマンド ID を設定します。

void SetCommandID(UINT nCommandID);

パラメーター

nCommandID
[in]コマンド ID。

解説

カラー バー コントロールのコマンド ID を変更し、ID が変更されたことをコントロールの親ウィンドウに通知するには、このメソッドを呼び出します。

CMFCColorBar::SetDocumentColors

現在の文書で使用されている色の一覧を設定します。

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

パラメーター

lpszCaption
[in]カラー バー コントロールがドッキングされていないときに表示されるキャプション。

lstDocColors
[in]現在のドキュメントの色を置き換える色の一覧。

bShowWhenDocked
[in]TRUE を指定すると、カラー バー コントロールがドッキングされたときにドキュメントの色が表示されます。それ以外の場合は FALSE。 既定値は FALSE です。

解説

ドキュメントの色 は、ドキュメントで現在使用されている色です。 フレームワークはドキュメントの色のリストを自動的に保持しますが、このメソッドを使用してリストを変更できます。

CMFCColorBar::SetHorzMargin

左右の色のセルとクライアント領域の境界との間のスペースである水平方向の余白を設定します。

void SetHorzMargin(int nHorzMargin);

パラメーター

nHorzMargin
[in]水平方向の余白 (ピクセル単位)。

解説

既定では、 CMFCColorBar::CMFCColorBar コンストラクターは水平方向の余白を 4 ピクセルに設定します。

CMFCColorBar::SetPropList

保護 m_pWndPropList データ メンバーを、プロパティ グリッド コントロールへの指定されたポインターに設定します。

void SetPropList(CMFCPropertyGridCtrl* pWndList);

パラメーター

pWndList
[in]プロパティ グリッド コントロール オブジェクトへのポインター。

CMFCColorBar::SetVertMargin

垂直方向の余白を設定します。これは、上または下の色のセルとクライアント領域の境界の間のスペースです。

void SetVertMargin(int nVertMargin);

パラメーター

nVertMargin
[in]垂直方向の余白 (ピクセル単位)。

解説

既定では、 CMFCColorBar::CMFCColorBar コンストラクターは垂直方向の余白を 4 ピクセルに設定します。

CMFCColorBar::ShowCommandMessageString

ステータス バーのメッセージ行を更新するために、カラー バー コントロールを所有するフレーム ウィンドウを要求します。

virtual void ShowCommandMessageString(UINT uiCmdId);

パラメーター

uiCmdId
[in]コマンド ID。 (このパラメーターは無視されます)。

解説

このメソッドは、WM_SETMESSAGESTRING メッセージをカラー バー コントロールの所有者に送信します。

関連項目

階層図
クラス