IAppointmentLabelStorage Interface

An interface that defines a storage which holds appointment labels.

Namespace: DevExpress.XtraScheduler

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

Declaration

C#

public interface IAppointmentLabelStorage :
    IStorageCollection<IAppointmentLabel>,
    IEnumerable<IAppointmentLabel>,
    ICollection,
    IEnumerable,
    IDisposable

VB.NET

Public Interface IAppointmentLabelStorage
    Inherits IStorageCollection(Of IAppointmentLabel),
             IEnumerable(Of IAppointmentLabel),
             ICollection,
             IEnumerable,
             IDisposable

Related API Members

The following members accept/return IAppointmentLabelStorage objects:

• IAppointmentStorageBase.Labels

Remarks

An object with the IAppointmentLabelStorage interface can be accessed using the IAppointmentStorageBase.Labels property or the SchedulerControl.DataStorage.Appointments.Labels notation.

Example

Note

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

LabelsAndStatuses.cs

    scheduler.InitAppointmentDisplayText += scheduler_InitAppointmentDisplayText;
    scheduler.ActiveView.LayoutChanged();
public static void scheduler_InitAppointmentDisplayText(object sender, AppointmentDisplayTextEventArgs e) {
    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());
}

LabelsAndStatuses.vb

    AddHandler scheduler.InitAppointmentDisplayText, AddressOf scheduler_InitAppointmentDisplayText
    scheduler.ActiveView.LayoutChanged()
Public Shared Sub scheduler_InitAppointmentDisplayText(ByVal sender As Object, ByVal e As AppointmentDisplayTextEventArgs)
    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())
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the IAppointmentLabelStorage 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#

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

#region #ChangingLabelColorScheme
IAppointmentLabelStorage labelStorage = scheduler.DataStorage.Appointments.Labels;
foreach (IAppointmentLabel label in labelStorage) {

wpf-schedulercontrol-api-t442105/CS/SchedulerControl_WPF_API/CodeExamples/LabelsAndStatuses.cs#L20

IAppointmentLabelStorage labelStorage = scheduler.Storage.AppointmentStorage.Labels;
labelStorage.Clear();

VB.NET

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

'            #Region "#ChangingLabelColorScheme"
Dim labelStorage As IAppointmentLabelStorage = scheduler.DataStorage.Appointments.Labels
For Each label As IAppointmentLabel In labelStorage

wpf-schedulercontrol-api-t442105/VB/SchedulerControl_WPF_API/CodeExamples/LabelsAndStatuses.vb#L18

Dim labelStorage As IAppointmentLabelStorage = scheduler.Storage.AppointmentStorage.Labels
labelStorage.Clear()