AppointmentStatus Class

An appointment's availability status.

Namespace: DevExpress.Xpf.Scheduler

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

Declaration

public class AppointmentStatus :
    UserInterfaceObjectWpf,
    IAppointmentStatus,
    IUserInterfaceObject,
    IDisposable
Public Class AppointmentStatus
    Inherits UserInterfaceObjectWpf
    Implements IAppointmentStatus,
               IUserInterfaceObject,
               IDisposable

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.

The AppointmentStatus class represents an individual availability status which can be associated with an appointment. The availability status is one of an appointment's basic visual characteristics. It is used for at-a-glance appointment identification. The appointment's availability status is indicated in the Scheduler control as a strip displayed on appointment's rectangle left side. The strip is colored in various ways, depending upon the availability status's type.

DXScheduler_AppointmentStatus

The color fill and type of an AppointmentStatus object can be specified via its AppointmentStatus.Brush and AppointmentStatus.Type properties. Note that availability status objects can be either the standard type (there are five standard predefined types - free, tentative, busy, out of office, working elsewhere) or a custom type. See the AppointmentStatusType enumerator for more details.

Availability status objects are contained within the AppointmentStatusCollection collection which can be accessed via the AppointmentStorage.Statuses property.

In order to associate an appointment with a particular availability status specified by its index within the AppointmentStorage.Statuses collection, the appointment's Appointment.StatusId property can be used.

NOTE

Availability status is only visible under the Day View or Work-Week View.

Examples

This example demonstrates how to add items to the collection of appointment statuses within the appointment storage using the AppointmentStorage.Statuses property.

<dxsch:AppointmentStorage>
    <dxsch:AppointmentStorage.Statuses>
        <dxsch:AppointmentStatus Color="YellowGreen" DisplayName="Reserved" MenuCaption="Reserved"/>
        <dxsch:AppointmentStatus Color="Green" DisplayName="Confirmed" MenuCaption="Confirmed"/>
    </dxsch:AppointmentStorage.Statuses>
</dxsch:AppointmentStorage>

Inheritance

Object
UserInterfaceObject
DevExpress.Xpf.Scheduler.UserInterfaceObjectWpf
AppointmentStatus
See Also