AppointmentLabel.GetDefaultColorByStringId(SchedulerColorId) Method

Obtains a color from the legacy label color scheme.

Namespace: DevExpress.XtraScheduler

Assembly: DevExpress.XtraScheduler.v18.2.dll

Declaration

C#

public static Color GetDefaultColorByStringId(
    SchedulerColorId colorId
)

VB.NET

Public Shared Function GetDefaultColorByStringId(
    colorId As SchedulerColorId
) As Color

Parameters

Name	Type	Description
colorId	SchedulerColorId	A SchedulerColorId enumeration member that specifies a legacy Scheduler label whose color is obtained.

Returns

Type	Description
Color	A Color that is the label color.

Remarks

The GetDefaultColorByStringId method allows you to obtain default label colors from the legacy color scheme, i.e., a default scheme unrelated to the current Skins.

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.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/winforms-schedulercontrol-api-t224044

LabelsAndStatuses.cs

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);
    }
    scheduler.ActiveView.LayoutChanged();
}

LabelsAndStatuses.vb

Dim labelStorage As IAppointmentLabelStorage = scheduler.Storage.Appointments.Labels
For Each label As IAppointmentLabel In labelStorage
    Dim appLabel As AppointmentLabel = TryCast(label, AppointmentLabel)
    If appLabel IsNot Nothing Then
        Dim skinElemName As String = AppointmentLabel.GetSkinElementName(appLabel.ColorId)
        Dim skinColor As Color = DevExpress.Skins.SkinManager.Default.Skins("Office 2016 Colorful").GetSkin(DevExpress.Skins.SkinProductId.Scheduler).Colors.GetPrimaryColor(skinElemName, Color.Empty)
        If skinColor = Color.Empty Then
            skinColor = AppointmentLabel.GetDefaultColorByStringId(appLabel.ColorId)
        End If
        appLabel.SetColor(skinColor)
    End If
    scheduler.ActiveView.LayoutChanged()
Next label

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GetDefaultColorByStringId(SchedulerColorId) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-schedulercontrol-api-t224044/CS/SchedulerAPISample/CodeExamples/LabelsAndStatuses.cs#L53

if (skinColor == Color.Empty)
    skinColor = AppointmentLabel.GetDefaultColorByStringId(appLabel.ColorId);
appLabel.SetColor(skinColor);

VB.NET

winforms-schedulercontrol-api-t224044/VB/SchedulerAPISample/CodeExamples/LabelsAndStatuses.vb#L52

If skinColor = Color.Empty Then
    skinColor = AppointmentLabel.GetDefaultColorByStringId(appLabel.ColorId)
End If