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

Adds a new appointment label item with the specified settings to the collection.

Namespace: DevExpress.Web.ASPxScheduler

Assembly: DevExpress.Web.ASPxScheduler.v23.2.dll

NuGet Package: DevExpress.Web.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 containing the menu caption for the command used to set the label for an appointment.
labelColor	Color	A Color specifying the color that represents the label.

Returns

Type	Description
Int32	An integer value indicating the position at which the new element was inserted.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Add(Object, String, String, Color) method.

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#

asp-net-web-forms-create-responsive-web-app/CS/ResponsiveWebApplication/Scheduler.aspx.cs#L29

    foreach(SchedulerLabel label in SchedulerLabelsHelper.GetItems())
        Scheduler.Storage.Appointments.Labels.Add(label.Id, label.Name, label.Name, label.Color);
}