CColorDialog Class

Article
01/08/2013

Allows you to incorporate a color-selection dialog box into your application.

class CColorDialog : public CCommonDialog

Members

Public Constructors

Name	Description
CColorDialog::CColorDialog	Constructs a CColorDialog object.

Public Methods

Name	Description
CColorDialog::DoModal	Displays a color dialog box and allows the user to make a selection.
CColorDialog::GetColor	Returns a COLORREF structure containing the values of the selected color.
CColorDialog::GetSavedCustomColors	Retrieves custom colors created by the user.
CColorDialog::SetCurrentColor	Forces the current color selection to the specified color.

Protected Methods

Name	Description
CColorDialog::OnColorOK	Override to validate the color entered into the dialog box.

Public Data Members

Name	Description
CColorDialog::m_cc	A structure used to customize the settings of the dialog box.

Remarks

A CColorDialog object is a dialog box with a list of colors that are defined for the display system. The user can select or create a particular color from the list, which is then reported back to the application when the dialog box exits.

To construct a CColorDialog object, use the provided constructor or derive a new class and use your own custom constructor.

Once the dialog box has been constructed, you can set or modify any values in them_cc structure to initialize the values of the dialog box's controls. The m_cc structure is of type CHOOSECOLOR.

After initializing the dialog box's controls, call the DoModal member function to display the dialog box and allow the user to select a color. DoModal returns the user's selection of either the dialog box's OK (IDOK) or Cancel (IDCANCEL) button.

If DoModal returns IDOK, you can use one of CColorDialog's member functions to retrieve the information input by the user.

You can use the Windows CommDlgExtendedError function to determine whether an error occurred during initialization of the dialog box and to learn more about the error.

CColorDialog relies on the COMMDLG.DLL file that ships with Windows versions 3.1 and later.

To customize the dialog box, derive a class from CColorDialog, provide a custom dialog template, and add a message map to process the notification messages from the extended controls. Any unprocessed messages should be passed to the base class.

Customizing the hook function is not required.

Note

On some installations the CColorDialog object will not display with a gray background if you have used the framework to make other CDialog objects gray.

For more information on using CColorDialog, see Common Dialog Classes