SchedulerBackgroundColor (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

SchedulerBackgroundColor (Function)

In french: PlanningCouleurFond

Defines a background color for a time period in a Scheduler control (time period corresponding to lunch time, a public holiday, etc.).

Caution: The modified background color is not the appointment one but the one of the specified time period.

Example

// November 12, 13 and 14, 2017 will be displayed on a red background
SchedulerBackgroundColor(SCH_MySchedule, "20171012", "20171015", "Room ABC", iLightRed)
SchedulerBackgroundColor(SCH_MySchedule, "20171012", "20171015", "Green room", iLightRed)
SchedulerBackgroundColor(SCH_MySchedule, "20171019", "20171020", "Green Room", iLightGreen)
SchedulerBackgroundColor(SCH_MySchedule, "20171017", "20171019", "", iDarkBlue)

Syntax

SchedulerBackgroundColor(<Scheduler control> , <Start of time period> , <End of time period> , <Resource> , <Color>)

<Scheduler control>: Control name

Name of the Scheduler control used, found in a window.

<Start of time period>: Character string or DateTime variable

Start date and time of time period to color.
If the date format is 00000000HHMMSS, all the days are affected.
If the date format is YYYYMMDD, all the hours of the day are affected.

<End of time period>: Character string or DateTime variable

End date and time of time period to color.

<Resource>: Character string

Name of resource affected by the change of background color for the time period.
Empty string ("") to modify the background color of time period for all resources.

<Color>: Integer or Integer constant

Background color of time period. This color can correspond to:
an RGB color (returned by RGB),
an HSL color (returned by HSL),
a WLanguage preset color.
Remark: If this parameter corresponds to -1 or to the transparent constant, the default background color is restored.

Remarks

The granularity of time period using a specific background color is limited to the granularity of drawing.
The time periods must not overlap. Otherwise, the result may differ from the expected one.

Component: wd270mdl.dll