Skip to main content

Appointment Mappings

  • 3 minutes to read

Note

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.

Mapping

Data Type

Description

AllDay

Boolean

Maps to the Appointment.AllDay property. Not required.

AppointmentId

Object (any type)

Maps to the PersistentObject.Id property. Appointment identity. Should be unique. This mapping is required for the Gantt View only to establish and maintain appointment relations. Other views, the SchedulerStorage and built-in appointment operations do not use the value of the Appointment.Id property. Therefore, if your application relies on Appointment.Id, you should provide methods for assigning the ID and updating the underlying data source with the actual ID value, as described in the PersistentObject.Id article.

Consider using the AppointmentStorage.CommitIdToDataSource and the AppointmentStorage.AutoRetrieveId properties in different identifier generation scenarios.

Description

String

Maps to the Appointment.Description property. Not required.

End

DateTime

Maps to the Appointment.End property. Required.

Label

Object (any type)

Maps to the Appointment.LabelKey property. The Label identifier. Not required.

Location

String

Maps to the Appointment.Location property. Not required.

OriginalOccurrenceStart

DateTime

Maps to the Appointment.OriginalOccurrenceStart property. Not required. Used in scenarios which handle the FetchAppointments event for recurring appointments.

OriginalOccurrenceEnd

DateTime

Maps to the Appointment.OriginalOccurrenceEnd property. Not required. Used in scenarios which handle the FetchAppointments event for recurring appointments.

PercentComplete

Integer

Maps to the Appointment.PercentComplete property. Not required. Used for the Gantt View only.

ResourceId

Object (any type)

Maps to the Appointment.ResourceId property. Required for identifying a resource for the appointment. Should be the same type as the ID Resource mapping.

ResourceIds

String

Maps to the Appointment.ResourceIds property. Required for associating multiple resources with appointments, when the SchedulerControl.ResourceSharing property is set to true. The data is composed of tags and attributes that specify the ID type and the ID value of associated resources. Starting from version 15.2 resource identifiers are of Object type so they are serialized using Base64 encoding. Set the SchedulerCompatibility.Base64XmlObjectSerialization property to false to store them as integers.

RecurrenceInfo

String

Maps to the Appointment.RecurrenceInfo property. Not required. The data is a list of attributes with values. If the appointment is the first in the chain, the data contains a unique pattern identifier, and parameters that describe the recurrence pattern. If the appointment is not the first member in a chain, the data contains a pattern identifier and the index in the chain.

ReminderInfo

String

Used to create a reminder specified by the Appointment.Reminder property. Not required. The data is a list of attributes with values. The attribute values are specified for the ReminderBase.AlertTime value and the ReminderBase.TimeBeforeStart value.

Start

DateTime

Maps to the Appointment.Start property. Required.

Status

Object (any type)

Maps to the Appointment.StatusKey property. The Status identifier. Not required.

Subject

String

Maps to the Appointment.Subject property. Not required.

TimeZoneId

String

Maps to the Appointment.TimeZoneId property. Not required. Used to store the original time zone for the appointment.

Type

Integer

Maps to the Appointment.Type property. Contains integer values that correspond to the AppointmentType enumeration. Required if the RecurrenceInfo mapping is set and the recurrence is enabled.