SchedulerStorage.GetLabelColor(Object) Method

Obtains the color of the label by its ID.

Namespace: DevExpress.Xpf.Scheduler

Assembly: DevExpress.Xpf.Scheduler.v18.2.dll

Declaration

C#

public virtual Color GetLabelColor(
    object labelId
)

VB.NET

Public Overridable Function GetLabelColor(
    labelId As Object
) As Color

Parameters

Name	Type	Description
labelId	Object	An object that is the label’s identifier available by the PersistentObject.Id property of the AppointmentLabel object.

Returns

Type	Description
Color	A Color value that is the label’s color.

Remarks

Important

You are viewing documentation for the legacy WPF Scheduler control. If you’re starting a new project, we strongly recommend that you use a new control declared in the DevExpress.Xpf.Scheduling namespace. If you decide to upgrade an existing project in order to switch to the updated scheduler control, see the Migration Guidelines document.

Use the GetLabelColor method to obtain the color of a label with a known ID.

If the label with the specified ID is not found, a default value for the Color is returned.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GetLabelColor(Object) 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#

how-to-display-appointments-in-agenda-view-by-using-the-dxgrid-for-wpf-component-t239055/CS/AgendaViewDataGenerator.cs#L66

agendaAppointment.AgendaStatus = storage.AppointmentStorage.Statuses[sourceAppointment.StatusId];
agendaAppointment.AgendaLabel = storage.GetLabelColor(sourceAppointment.LabelId);
agendaAppointment.SourceAppointment = sourceAppointment;

VB.NET

how-to-display-appointments-in-agenda-view-by-using-the-dxgrid-for-wpf-component-t239055/VB/AgendaViewDataGenerator.vb#L65

agendaAppointment.AgendaStatus = storage.AppointmentStorage.Statuses(sourceAppointment.StatusId)
agendaAppointment.AgendaLabel = storage.GetLabelColor(sourceAppointment.LabelId)
agendaAppointment.SourceAppointment = sourceAppointment