MonthCal_SetColor macro (commctrl.h)

Article
10/23/2024

Sets the color for a given portion of a month calendar control. You can use this macro or send the MCM_SETCOLOR message explicitly.

Syntax

COLORREF MonthCal_SetColor(
   HWND     hmc,
   INT      iColor,
   COLORREF clr
);

Parameters

hmc

Type: HWND

Handle to a month calendar control.

iColor

Type: INT

Value of type int specifying which month calendar color to set. This value can be one of the following:

Value	Meaning
MCSC_BACKGROUND	Set the background color displayed between months.
MCSC_MONTHBK	Set the background color displayed within the month.
MCSC_TEXT	Set the color used to display text within a month.
MCSC_TITLEBK	Set the background color displayed in the calendar's title.
MCSC_TITLETEXT	Set the color used to display text within the calendar's title.
MCSC_TRAILINGTEXT	Set the color used to display header day and trailing day text. Header and trailing days are the days from the previous and following months that appear on the current month calendar.

clr

Type: COLORREF

COLORREF value that represents the color that will be set for the specified area of the month calendar.

Return value

Type: COLORREF

Returns a COLORREF value that represents the previous color setting for the specified portion of the month calendar control if successful. Otherwise, the return is -1.

Remarks

If visual styles are active, this macro has no effect except when iColor is MCSC_BACKGROUND.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	commctrl.h

Share via