Skip to main content

DxSchedulerDataStorage.AppointmentStatusMappings Property

Specifies an object that defines how status item properties are mapped to data source fields.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v23.2.dll

NuGet Package: DevExpress.Blazor


public DxSchedulerAppointmentStatusMappings AppointmentStatusMappings { get; set; }

Property Value

Type Description

Stores information on how data source fields are mapped to appointment status properties.


The appointment displays its availability status as a colored strip on the left edge. The Scheduler has a built-in collection of status values:

Scheduler -  Default appointment statuses

You can use the AppointmentStatusMappings property to create a collection of your own status values:

  1. Create a DxSchedulerDataStorage object that uses a constructor without parameters and specify appointment mappings. See the DxSchedulerAppointmentMappings class description for more information.
  2. Declare a class (for instance, StatusObject) that stores status options and an ID.
  3. Create a collection of status source objects (StatusObject class instances) and define their options.
  4. Assign the newly created collection to the storage’s AppointmentStatusSource property.
  5. Assign the DxSchedulerAppointmentStatusMappings object to the AppointmentStatusMappings property. In this object, map the status item’s source fields to the status item’s properties.
  6. Optional. You can create custom fields for status items. Define custom fields in the status item’s source object and add these fields to the CustomFieldMappings collection. For instance, the code below adds the MyCustomField field to the StatusObject and maps this field to the status item’s MyCustomProperty.
<DxScheduler StartDate="@DateTime.Today"
    <DxSchedulerWeekView ShowWorkTimeOnly="true"></DxSchedulerWeekView>

@code {
    DxSchedulerDataStorage DataStorage = new DxSchedulerDataStorage() {
        // Specify appointment mappings here.
        // ...
        AppointmentStatusSource = StatusCollection.GetStatuses(),
        AppointmentStatusMappings = new DxSchedulerAppointmentStatusMappings() {
            Id = "Id",
            Caption = "StatusCaption",
            Color = "StatusColor",
            // Uncomment the line below and comment the line above to specify other style options.
            //CssClass = "CssClass",
            // Map the source object's custom field to the status item's custom property.
            CustomFieldMappings = new List<DxSchedulerCustomFieldMapping> {
                new DxSchedulerCustomFieldMapping { Name = "MyCustomProperty", Mapping = "MyCustomField" }

Scheduler Appointment Custom Status


When you use templates to customize appointment appearance, the Color and CssClass property values are not applied to appointments. To access these property values in the template, use the context.Status parameter.

See Also