AppointmentStatusCollection.Add(Color, String, String) Method

Creates a status with the specified settings and adds it to the collection.

Namespace: DevExpress.Xpf.Scheduler

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

NuGet Package: DevExpress.Wpf.Scheduler

Declaration

C#

public int Add(
    Color color,
    string displayName,
    string menuCaption
)

VB.NET

Public Function Add(
    color As Color,
    displayName As String,
    menuCaption As String
) As Integer

Parameters

Name	Type	Description
color	Color	A Color structure used to create a SolidColorBrush object for painting a status strip. The newly created brush is accessible with the AppointmentStatus.Brush property.
displayName	String	A string that is the name of the status used in editors. This string is also assigned to the UserInterfaceObject.MenuCaption property and used in menus.
menuCaption	String	A string used in a context menu that allows changing the status of an appointment.

Returns

Type	Description
Int32	An integer that is the position of status 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.

This method creates a status with a null identifier. The type of the added status is set to AppointmentStatusType.Custom.