AppointmentLabel.ColorId Property

Gets or sets the label identifier in a Scheduler legacy color scheme.

Namespace: DevExpress.XtraScheduler

Assembly: DevExpress.XtraScheduler.v21.1.dll

Declaration

[Browsable(false)]
[EditorBrowsable(EditorBrowsableState.Never)]
public SchedulerColorId ColorId { get; set; }

Property Value

Type Description
SchedulerColorId

A SchedulerColorId enumeration member that specifies the label color.

Available values:

Show 12 items
Name Description
Nothing

Indicates that the color is specified using the AppointmentLabel.Color property and does not correlate to SchedulerColorId enumeration members.

NoneLabel

The None label color. The legacy default color is shown below:

AppointmentLabel.None

ImportantLabel

The Important label color. The legacy default color is shown below:

AppointmentLabel.Important

BusinessLabel

The Business label color. The legacy default color is shown below:

AppointmentLabel.Business

PersonalLabel

The Personal label color. The legacy default color is shown below:

AppointmentLabel.Personal

VacationLabel

The Vacation label color. The legacy default color is shown below:

AppointmentLabel.Vacation

MustAttendLabel

The Must Attend label color. The legacy default color is shown below:

AppointmentLabel.MustAttend

TravelRequiredLabel

The Travel Required label color. The legacy default color is shown below:

AppointmentLabel.TravelRequired

NeedsPreparationLabel

The Needs Preparation label color. The legacy default color is shown below:

AppointmentLabel.NeedsPreparation

BirthdayLabel

The Birthday label color. The legacy default color is shown below:

AppointmentLabel.Birthday

AnniversaryLabel

The Anniversary label color. The legacy default color is shown below:

AppointmentLabel.Anniversary

PhoneCallLabel

The Phone Call label color. The legacy default color is shown below:

AppointmentLabel.PhoneCall

Remarks

Use the ColorId property to set the label color to the color defined in the label color scheme. The label color scheme can be a legacy default scheme or can be obtained from a skin.

Example

This example changes the label colors. For each label it attempts to get a label color defined in a specified skin. If it fails, a default legacy color is used.

View Example

IAppointmentLabelStorage labelStorage = scheduler.Storage.Appointments.Labels;
foreach (IAppointmentLabel label in labelStorage) {
    AppointmentLabel appLabel = label as AppointmentLabel;
    if (appLabel != null) {
        string skinElemName = AppointmentLabel.GetSkinElementName(appLabel.ColorId);
        Color skinColor = DevExpress.Skins.SkinManager.Default.Skins["Office 2016 Colorful"].GetSkin(DevExpress.Skins.SkinProductId.Scheduler).Colors.GetPrimaryColor(skinElemName, Color.Empty);
        if (skinColor == Color.Empty)
            skinColor = AppointmentLabel.GetDefaultColorByStringId(appLabel.ColorId);
        appLabel.SetColor(skinColor);
    }

}
See Also