IAppointmentLabel Interface

Platform-independent interface that defines the appointment label.

Namespace: DevExpress.XtraScheduler

Assembly: DevExpress.XtraScheduler.v18.1.Core.dll

Declaration

C#

public interface IAppointmentLabel :
    IUserInterfaceObject,
    IDisposable

VB.NET

Public Interface IAppointmentLabel
    Inherits IUserInterfaceObject,
             IDisposable

Related API Members

The following members accept/return IAppointmentLabel objects:

Library	Related API Members
Cross-Platform Class Library	IAppointmentLabelStorage.CreateNewLabel(Object, String)
	IAppointmentLabelStorage.CreateNewLabel(Object, String, String)
	IAppointmentLabelStorage.CreateNewLabel(String)
WinForms Controls	AppointmentFormController.AppointmentLabel
	AppointmentLabelEdit.AppointmentLabel
WPF Controls	AppointmentInplaceEditorBase.Label
	AppointmentViewInfo.Label

Remarks

Appointment labels are implemented with the following platform-specific classes:

Platform	Class
WinForms	AppointmentLabel
WPF	AppointmentLabel
ASP.NET	AppointmentLabel

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the IAppointmentLabel interface.

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-show-color-icons-for-labels-and-statuses-in-the-appointment-edit-form-and-popup-menu-t344486/CS/CustomFormStatusEditors/DevExpress/ASPxSchedulerForms/AppointmentForm.ascx.cs#L63

IAppointmentStorageBase appointmentStorage = container.Control.Storage.Appointments;
IAppointmentLabel label = appointmentStorage.Labels.GetById(apt.LabelKey);
IAppointmentStatus status = appointmentStorage.Statuses.GetById(apt.StatusKey);

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

SchedulerControl scheduler = sender as SchedulerControl;
IAppointmentLabel label = scheduler.DataStorage.Appointments.Labels.GetById(e.Appointment.LabelKey);
e.Description = String.Format("Label Info:\nDisplayName = '{0}'\nID = '{1}'", label.DisplayName, label.Id.ToString());

how-to-show-images-for-tentative-and-working-elsewhere-appointment-statuses-t344062/CS/CustomStatusSample/DevExpress/ASPxSchedulerForms/AppointmentForm.ascx.cs#L63

IAppointmentStorageBase appointmentStorage = container.Control.Storage.Appointments;
IAppointmentLabel label = appointmentStorage.Labels.GetById(apt.LabelKey);
IAppointmentStatus status = appointmentStorage.Statuses.GetById(apt.StatusKey);

how-to-use-datetimenavigation-service-e154/CS/Form1.cs#L107

void AddAppointmentLabel(object id, string displayName, Color color) {
    IAppointmentLabel label = this.schedulerStorage1.Appointments.Labels.CreateNewLabel(id, displayName);
    label.SetColor(color);

service-substitution-use-keyboard-and-mouse-services-to-implement-zooming-e677/CS/ServicesMouseZoom/Form1.cs#L151

void AddAppointmentLabel(object id, string displayName, Color color) {
    IAppointmentLabel label = this.schedulerStorage1.Appointments.Labels.CreateNewLabel(id, displayName);
    label.SetColor(color);

VB.NET

how-to-show-color-icons-for-labels-and-statuses-in-the-appointment-edit-form-and-popup-menu-t344486/VB/CustomFormStatusEditors/CustomForms/CusomAppointmentForm.ascx.vb#L70

Dim appointmentStorage As IAppointmentStorageBase = container.Control.Storage.Appointments
Dim label As IAppointmentLabel = appointmentStorage.Labels.GetById(apt.LabelKey)
Dim status As IAppointmentStatus = appointmentStorage.Statuses.GetById(apt.StatusKey)

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

Dim scheduler As SchedulerControl = TryCast(sender, SchedulerControl)
Dim label As IAppointmentLabel = scheduler.DataStorage.Appointments.Labels.GetById(e.Appointment.LabelKey)
e.Description = String.Format("Label Info:" & ControlChars.Lf & "DisplayName = '{0}'" & ControlChars.Lf & "ID = '{1}'", label.DisplayName, label.Id.ToString())

how-to-show-images-for-tentative-and-working-elsewhere-appointment-statuses-t344062/VB/CustomStatusSample/DevExpress/ASPxSchedulerForms/AppointmentForm.ascx.vb#L70

Dim appointmentStorage As IAppointmentStorageBase = container.Control.Storage.Appointments
Dim label As IAppointmentLabel = appointmentStorage.Labels.GetById(apt.LabelKey)
Dim status As IAppointmentStatus = appointmentStorage.Statuses.GetById(apt.StatusKey)

how-to-use-datetimenavigation-service-e154/VB/Form1.vb#L104

Private Sub AddAppointmentLabel(ByVal id As Object, ByVal displayName As String, ByVal color As Color)
    Dim label As IAppointmentLabel = Me.schedulerStorage1.Appointments.Labels.CreateNewLabel(id, displayName)
    label.SetColor(color)

service-substitution-use-keyboard-and-mouse-services-to-implement-zooming-e677/VB/ServicesMouseZoom/Form1.vb#L152

Private Sub AddAppointmentLabel(ByVal id As Object, ByVal displayName As String, ByVal color As Color)
    Dim label As IAppointmentLabel = Me.schedulerStorage1.Appointments.Labels.CreateNewLabel(id, displayName)
    label.SetColor(color)