blazor-devexpress-dot-blazor-018d9a84.md
Maps the label’s properties to the data source fields.
Namespace : DevExpress.Blazor
Assembly : DevExpress.Blazor.v25.2.dll
NuGet Package : DevExpress.Blazor
public class DxSchedulerAppointmentLabelMappings :
DxSchedulerMappingsBase
The following members return DxSchedulerAppointmentLabelMappings objects:
Users can use color labels to categorize appointments. A label is displayed as an appointment’s background. The Scheduler has a built-in collection of 11 color labels.
You can use the DxSchedulerAppointmentLabelMappings class to create a new collection with your own labels:
LabelObject) that stores label settings and an ID.LabelObject class instances) and define their settings.DxSchedulerAppointmentLabelMappings object to the AppointmentLabelMappings property. In this object, map the label’s source fields to the label’s properties.MyCustomField field to the LabelObject and maps this field to the label’s MyCustomProperty.<DxScheduler DataStorage="@DataStorage">
<Views>
<DxSchedulerDayView DayCount="3"
TimeScale="@(new TimeSpan(1,0,0))"
WorkTime="new DxSchedulerTimeSpanRange(TimeSpan.FromHours(9), TimeSpan.FromHours(18))"
VisibleTime="new DxSchedulerTimeSpanRange(TimeSpan.FromHours(8), TimeSpan.FromHours(19))"
TimeIndicatorVisibility="SchedulerTimeIndicatorVisibility.Never">
</DxSchedulerDayView>
<DxSchedulerWeekView ShowWorkTimeOnly="true" />
<DxSchedulerWorkWeekView ShowWorkTimeOnly="true" />
</Views>
<AppointmentCompactFormLayout Context="formInfo">
<DxSchedulerSubjectFormLayoutItem></DxSchedulerSubjectFormLayoutItem>
<DxSchedulerDescriptionFormLayoutItem></DxSchedulerDescriptionFormLayoutItem>
<DxSchedulerLabelFormLayoutItem></DxSchedulerLabelFormLayoutItem>
</AppointmentCompactFormLayout>
</DxScheduler>
@code {
DxSchedulerDataStorage DataStorage = new DxSchedulerDataStorage() {
// Specify appointment mappings here
// ...
AppointmentLabelsSource = LabelCollection.GetLabels(),
AppointmentLabelMappings = new DxSchedulerAppointmentLabelMappings() {
Id = "Id",
Caption = "LabelCaption",
Color = "LabelColor",
// Uncomment the line below and comment the line above to specify other background options.
//BackgroundCssClass = "BackgroundCssClass",
TextCssClass = "TextCssClass",
// Map the source object's custom field to the label's custom property.
CustomFieldMappings = new List<DxSchedulerCustomFieldMapping> {
new DxSchedulerCustomFieldMapping { Name = "MyCustomProperty", Mapping = "MyCustomField" }
}
}
};
}
.label1-background {
background-color: lightblue;
border-color: blue;
}
.label2-background {
background-color: lightgreen;
border-color: green;
}
.label1-text {
color: blue;
}
.label2-text {
color: green;
}
public class LabelObject {
public int Id { get; set; }
public string LabelCaption { get; set; }
public System.Drawing.Color LabelColor { get; set; }
public string TextCssClass { get; set; }
public string BackgroundCssClass { get; set; }
public string MyCustomField { get; set; } // A custom field
}
public static class LabelCollection {
public static List<LabelObject> GetLabels() {
DateTime date = DateTime.Today;
var dataSource = new List<LabelObject>() {
new LabelObject() {
Id = 1,
LabelCaption = "Label One",
LabelColor = System.Drawing.Color.LightBlue,
// Uncomment the line below and comment the line above to specify other background options.
// BackgroundCssClass = "label1-background",
TextCssClass = "label1-text",
MyCustomField = "Custom text for Label One",
},
new LabelObject() {
Id = 2,
LabelCaption = "Label Two",
LabelColor = System.Drawing.Color.LightGreen,
// Uncomment the line below and comment the line above to specify other background options.
// BackgroundCssClass = "label2-background",
TextCssClass = "label2-text",
MyCustomField = "Custom text for Label Two",
},
};
return dataSource;
}
}
Note
When you use templates to customize appointment appearance, the Color, BackgroundCssClass, and TextCssClass property values are not applied to appointments. In the template, you can use the context.Label parameter to access these property values.
Object DevExpress.Blazor.Scheduler.Internal.BindableBase DxSchedulerMappingsBase DxSchedulerAppointmentLabelMappings
See Also