IAppointmentLabelStorage.CreateNewLabel(Object, String, String) Method

Creates a new label with the specified name, identifier and menu caption.

Namespace: DevExpress.XtraScheduler

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

Declaration

C#

IAppointmentLabel CreateNewLabel(
    object id,
    string displayName,
    string menuCaption
)

VB.NET

Function CreateNewLabel(
    id As Object,
    displayName As String,
    menuCaption As String
) As IAppointmentLabel

Parameters

Name	Type	Description
id	Object	A Object that is the unique label identifier used in the Appointment.LabelId property.
displayName	String	A string that is the name of a label to use in appointment label editors.
menuCaption	String	A string used as a caption in context menu for changing the appointment label.

Returns

Type	Description
IAppointmentLabel	An IAppointmentLabel object that is a new label.

Example

This code illustrates how to substitute default appointment labels and statuses with your own.

Remove default labels and statuses by calling the Clear method of the AppointmentLabelCollection and AppointmentStatusCollection collections respectively. Subsequently, create a new label using the AppointmentLabelCollection.CreateNewLabel method, specify its AppointmentLabel.Color and add the newly created label to the collection. Create a new appointment status using the AppointmentStatusCollection.CreateNewStatus method, specify its appearance with the AppointmentStatusExtension.SetBrush method and add the newly created status to the collection.

Note

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

LabelsAndStatuses.cs

scheduler.Storage.Appointments.Clear();

string[] IssueList = { "Consultation", "Treatment", "X-Ray" };
Color[] IssueColorList = { Color.Ivory, Color.Pink, Color.Plum };
string[] PaymentStatuses = { "Paid", "Unpaid" };
Color[] PaymentColorStatuses = { Color.Green, Color.Red };


IAppointmentLabelStorage labelStorage = scheduler.Storage.Appointments.Labels;
labelStorage.Clear();
int count = IssueList.Length;
for (int i = 0; i < count; i++) {
    IAppointmentLabel label = labelStorage.CreateNewLabel(i, IssueList[i]);
    label.SetColor(IssueColorList[i]);
    labelStorage.Add(label);
}
AppointmentStatusCollection statusColl = scheduler.Storage.Appointments.Statuses;
statusColl.Clear();
count = PaymentStatuses.Length;
for (int i = 0; i < count; i++) {
    AppointmentStatus status = statusColl.CreateNewStatus(i, PaymentStatuses[i], PaymentStatuses[i]);
    status.SetBrush(new SolidBrush(PaymentColorStatuses[i]));
    statusColl.Add(status);
}

LabelsAndStatuses.vb

scheduler.Storage.Appointments.Clear()

Dim IssueList() As String = {"Consultation", "Treatment", "X-Ray"}
Dim IssueColorList() As Color = {Color.Ivory, Color.Pink, Color.Plum}
Dim PaymentStatuses() As String = {"Paid", "Unpaid"}
Dim PaymentColorStatuses() As Color = {Color.Green, Color.Red}


Dim labelStorage As IAppointmentLabelStorage = scheduler.Storage.Appointments.Labels
labelStorage.Clear()
Dim count As Integer = IssueList.Length
For i As Integer = 0 To count - 1
    Dim label As IAppointmentLabel = labelStorage.CreateNewLabel(i, IssueList(i))
    label.SetColor(IssueColorList(i))
    labelStorage.Add(label)
Next i
Dim statusColl As AppointmentStatusCollection = scheduler.Storage.Appointments.Statuses
statusColl.Clear()
count = PaymentStatuses.Length
For i As Integer = 0 To count - 1
    Dim status As AppointmentStatus = statusColl.CreateNewStatus(i, PaymentStatuses(i), PaymentStatuses(i))
    status.SetBrush(New SolidBrush(PaymentColorStatuses(i)))
    statusColl.Add(status)
Next i