AppointmentLabelCollection.Add(SchedulerColorId, String, String) Method

Creates a new label with the specified color identifier and displayed name, and appends it to the collection of appointment labels.

Namespace: DevExpress.XtraScheduler

Assembly: DevExpress.XtraScheduler.v23.2.dll

NuGet Package: DevExpress.Win.Scheduler

Declaration

C#

public int Add(
    SchedulerColorId colorId,
    string displayName,
    string menuCaption
)

VB.NET

Public Function Add(
    colorId As SchedulerColorId,
    displayName As String,
    menuCaption As String
) As Integer

Parameters

Name	Type	Description
colorId	SchedulerColorId	A SchedulerColorId enumeration specifying the label’s color identifier.
displayName	String	A string that is the name of the label displayed in label editors.
menuCaption	String	A string that is the caption of a context menu used to change a label for an appointment.

Returns

Type	Description
Int32	An integer value indicating the position of the newly added label in the collection.

Remarks

This method creates a label with an identifier provided automatically by the AppointmentLabelCollection object.