[Expand]General Information
[Expand]WinForms Controls
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Collapse]WPF Controls
 [Expand]What's Installed
 [Expand].NET Core 3 Support
 [Expand]Common Concepts
 [Expand]MVVM Framework
 [Collapse]Controls and Libraries
  [Expand]Data Grid
  [Expand]Ribbon, Bars and Menu
  [Expand]Charts Suite
  [Expand]Pivot Grid
   [Expand]Getting Started
   [Expand]Visual Elements
   [Expand]Styles and Templates
   [Expand]Design-Time Features
    Time Zones
   [Expand]Data Binding
    Appearance Customization
    Clipboard Operations
    Printing Templates
    Drag and Drop Customization
    End-User Restrictions
    Migration Guidelines
  [Expand]Rich Text Editor
  [Expand]Tree List
  [Expand]Gauge Controls
  [Expand]Map Control
  [Expand]Layout Management
  [Expand]Windows Modern UI
  [Expand]Data Editors
  [Expand]Navigation Controls
  [Expand]Spell Checker
  [Expand]Property Grid
  [Expand]PDF Viewer
  [Expand]TreeMap Control
  [Expand]Gantt Control
  [Expand]Diagram Control
  [Expand]Windows and Utility Controls
   Dialogs, Notifications and Panels
  [Expand]Scheduler (legacy)
 [Expand]Scaffolding Wizard
  Redistribution and Deployment
  Get More Help
 [Expand]API Reference
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Office File API
[Expand]Report and Dashboard Server
[Expand]eXpressApp Framework
[Expand]eXpress Persistent Objects
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation
View this topic on docs.devexpress.com (Learn more)


Expanded Overview

A label is an object that is used to categorize appointments. It provides a caption and a color, so that end-users can assign a corresponding color to an appointment's background to identify appointments.

The image below shows appointments with different labels. An end-user can change the appointment's label in the context menu.

A label is an AppointmentLabelItem class instance that is assigned to an appointment using the AppointmentItem.LabelId property. All labels are contained in the SchedulerControl.LabelItems collection and you can use it to customize existing labels, remove them or add your own.

Expanded Default Labels

The SchedulerControl.LabelItems collection includes the following labels by default:

Color Color Value Display Name LabelId
System.Windows.Media.Colors.Transparent SchedulerStringId.AppointmentLabel_None 0
#FFFFC2BE SchedulerStringId.AppointmentLabel_Important 1
#FFA8D5FF SchedulerStringId.AppointmentLabel_Business 2
#FFC1F49C SchedulerStringId.AppointmentLabel_Personal 3
#FFF3E4C7 SchedulerStringId.AppointmentLabel_Vacation 4
#FFF4CE93 SchedulerStringId.AppointmentLabel_MustAttend 5
#FFC7F4FF SchedulerStringId.AppointmentLabel_TravelRequired 6
#FFCFDB98 SchedulerStringId.AppointmentLabel_NeedsPreparation 7
#FFE0CFE9 SchedulerStringId.AppointmentLabel_Birthday 8
#FF8DE9DF SchedulerStringId.AppointmentLabel_Anniversary 9
#FFFFF7A5 SchedulerStringId.AppointmentLabel_PhoneCall 10

Label colors are defined in the DevExpress WPF Theme resources using the theme key SchedulerThemeKey and ResourceKey=LabelColors. Different themes can have different label colors. Label colors are available using the SchedulerControl.LabelColors property.


Handle the SchedulerControl.InitNewAppointment event to initialize all newly created appointments with a specific label.

Expanded Binding to Data

Labels can be bound to a data source using the DataSource.AppointmentLabelsSource property. Map data fields to label properties using the AppointmentLabelMappings settings.

Expanded See Also

Is this topic helpful?​​​​​​​