AppointmentLabelCollection.Add(Object, String, String, Color) Method

Creates a new label with the specified settings and adds it to the collection of appointment labels.

Namespace: DevExpress.Xpf.Scheduler

Assembly: DevExpress.Xpf.Scheduler.v24.1.dll

NuGet Package: DevExpress.Wpf.Scheduler

Declaration

C#

public int Add(
    object id,
    string displayName,
    string menuCaption,
    Color labelColor
)

VB.NET

Public Function Add(
    id As Object,
    displayName As String,
    menuCaption As String,
    labelColor As Color
) As Integer

Parameters

Name	Type	Description
id	Object	An object that is the unique label identifier.
displayName	String	A string that is the name of the label displayed in label editors.
menuCaption	String	A string used for a context menu item that allows changing the label of an appointment.
labelColor	Color	A Color structure that specifies the color which indicates the label.

Returns

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

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 Add method to add custom appointment labels.