Skip to main content

TcxSchedulerEventLabels Class

The TcxSchedulerEventLabels class implements a collection which stores the instances of color labels.

Declaration

TcxSchedulerEventLabels = class(
    TCollection
)

Remarks

Color labels are used to color user events of particular types to facilitate end-users in identifying them. An end-user can assign (or change) a color label using the Label image combo box in the Event dialog or by selecting the Label item of the pop-up menu when it is invoked on a scheduled user event.

A color label has three attributes:

  • A color which is used to color a user event;

  • A name which describes the associated color;

  • An icon which is used as the color indicator to make it easier for an end-user to select the required label.

A color label is represented by the TcxSchedulerEventLabel class.

The TcxSchedulerEventLabels class implements the Add method to load a new color label with the specified color and name. It also declares the Images property to have an access to the collection of the built-in icons associated with the appropriate color labels.

Prior to the release of ExpressScheduler 2 a developer could only customize the colors and names of the user event‘s color labels by changing the predefined color labels – the EventLabelColors array’s values (the cxSchedulerUtils unit) and label resource strings (the cxSchedulerStrs unit).

Now only the TcxSchedulerEventLabels collection is used to specify the color labels. It stores the TcxSchedulerEventLabel objects which represent these labels. The color labels stored can be one of two types: built-in and custom. The built-in labels are added to the collection automatically. While the custom labels are loaded into it using the Add method.

The TcxSchedulerEventLabels object is referenced by the EventLabels variable.

Inheritance

TObject
TPersistent
TCollection
TcxSchedulerEventLabels
See Also