C++ Syntax

bool

MKI_DialogColor(

HWND f_hWindow,

const LPCWSTR f_pszCaption,

MKI_COLORVALUE_REF f_rData,

MKI_COLORMODEL_PTR f_pColorMode,

bool f_fByLayer );

Shows and processes a dialog for color selection (including custom colors).

Parameters

Window

[HWND] Handle of the dialog window's parent window.

Caption

[const LPCWSTR] Title of the dialog window to be displayed. Be careful that the given title fits into the dialog window's caption.

Data

[MKI_COLORVALUE_REF] Address of a color value. This color value is used to initialize the dialog window, and it will receive the selected color if the user ends the dialog by pressing the OK button.

ColorMode New in Version 6.60

[MKI_COLORMODEL_PTR] Address of a color mode (see MKI_COLORMODE_*). This color mode is used to initialize the dialog window, and it will receive the selected color if the user ends the dialog by pressing the OK button. If this value is nullptr, the dialog will not allow to select the color mode and will handle Data as a standard RGB color.

ByLayer New in Version 2014.2

[bool] If true and ColorMode is non-zero, the color mode MKI_COLORMODE_BYLAYER will be offered. Otherwise, the color mode MKI_COLORMODE_BYLAYER cannot be selected.

Return Value

Returns true if the dialog window was ended by pressing the OK button and anything inside the window was changed, else false.