DataSource Class

Specifies data sources and mappings for the scheduler’s appointments, labels, and statuses.

Namespace: DevExpress.Maui.Scheduler

Assembly: DevExpress.Maui.Scheduler.dll

NuGet Package: DevExpress.Maui.Scheduler

Declaration

public class DataSource :
    SchedulerElement,
    IDataSource

Related API Members

The following members return DataSource objects:

• SchedulerDataStorage.DataSource

Remarks

To bind a scheduler view to an external data source, set the view’s DataStorage property to a SchedulerDataStorage object and assign a DataSource object to the SchedulerDataStorage.DataSource property.

Use the AppointmentsSource, AppointmentLabelsSource and AppointmentStatusesSource properties to specify data sources for appointments, labels and statuses.

Note

The Scheduler allows you to delete only one item at a time.

Important

Each binding requires a corresponding mapping. Use the AppointmentMappings, AppointmentLabelMappings and AppointmentStatusMappings properties to map properties of appointment, label and status objects to data source fields.

Example

This example shows how to bind a DayView instance to a data source that stores custom appointment (MedicalAppointment) and label (MedicalAppointmentType) objects.

1. Assign a view model object to the content page’s BindingContext property.
2. Set the DayView.DataStorage property to a SchedulerDataStorage object.

3. Set the SchedulerDataStorage.DataSource property to a DataSource object and specify the following properties of this object:

   • AppointmentsSource and AppointmentMappings - bind the scheduler to the collection of appointment objects and map appointment properties to the MedicalAppointment class properties.
   • AppointmentLabelsSource and AppointmentLabelMappings - bind the scheduler to the collection of appointment labels and map appointment label properties to the MedicalAppointmentType class properties.
   C#: Model

   using System;
   using System.Collections.ObjectModel;
   using Microsoft.Maui.Controls;
   
   namespace SchedulerExample.Models {
       public class MedicalAppointment {
           public int Id { get; set; }
           public DateTime StartTime { get; set; }
           public DateTime EndTime { get; set; }
           public string Subject { get; set; }
           public int LabelId { get; set; }
           public string Location { get; set; }
       }
   
       public class MedicalAppointmentType {
           public int Id { get; set; }
           public string Caption { get; set; }
           public Color Color { get; set; }
       }
   
       public class ReceptionDeskData {
           public static DateTime BaseDate = DateTime.Today;
   
           public static string[] AppointmentTypes = { "Hospital", "Office", "Phone Consultation", "Home", "Hospice" };
           public static Color[] AppointmentTypeColors = { Color.FromHex("#dfcfe9"), Color.FromHex("#c2f49d"),
                                                           Color.FromHex("#8de8df"), Color.FromHex("#a8d5ff"),
                                                           Color.FromHex("#c8f4ff") };
   
   
           public static string[] PatientNames = { "Andrew Glover", "Mark Oliver", "Taylor Riley",
                                                   "Addison Davis", "Benjamin Hughes", "Lucas Smith",
                                                   "Robert King", "Laura Callahan", "Miguel Simmons",
                                                   "Isabella Carter", "Andrew Fuller", "Madeleine Russell",
                                                   "Steven Buchanan", "Nancy Davolio", "Michael Suyama",
                                                   "Margaret Peacock", "Janet Leverling", "Ariana Alexander",
                                                   "Brad Farkus", "Bart Arnaz", "Arnie Schwartz", "Billy Zimmer"};
   
           static Random rnd = new Random();
   
           void CreateMedicalAppointments() {
               int appointmentId = 1;
               int patientIndex = 0;
               DateTime start;
               TimeSpan duration;
               ObservableCollection<MedicalAppointment> result = new ObservableCollection<MedicalAppointment>();
               for (int i = -20; i < 20; i++)
                   for (int j = 0; j < 15; j++) {
                       int room = rnd.Next(1, 100);
                       start = BaseDate.AddDays(i).AddHours(rnd.Next(8, 17)).AddMinutes(rnd.Next(0, 40));
                       duration = TimeSpan.FromMinutes(rnd.Next(20, 30));
                       result.Add(CreateMedicAppointment(appointmentId, PatientNames[patientIndex],
                                                         start, duration, room));
                       appointmentId++;
                       patientIndex++;
                       if (patientIndex >= PatientNames.Length - 1)
                           patientIndex = 1;
                   }
               MedicalAppointments = result;
           }
   
           void CreateLabels() {
               ObservableCollection<MedicalAppointmentType> result = new ObservableCollection<MedicalAppointmentType>();
               int count = AppointmentTypes.Length;
               for (int i = 0; i < count; i++) {
                   MedicalAppointmentType appointmentType = new MedicalAppointmentType();
                   appointmentType.Id = i;
                   appointmentType.Caption = AppointmentTypes[i];
                   appointmentType.Color = AppointmentTypeColors[i];
                   result.Add(appointmentType);
               }
               Labels = result;
           }
   
           MedicalAppointment CreateMedicAppointment(int appointmentId, string patientName,
                                                       DateTime start, TimeSpan duration, int room) {
               MedicalAppointment medicalAppointment = new MedicalAppointment();
               medicalAppointment.Id = appointmentId;
               medicalAppointment.StartTime = start;
               medicalAppointment.EndTime = start.Add(duration);
               medicalAppointment.Subject = patientName;
               medicalAppointment.LabelId = Labels[rnd.Next(0, 5)].Id; // Assign a custom label to an appointment
               if (medicalAppointment.LabelId != 3)
                   medicalAppointment.Location = String.Format("{0}", room);
               return medicalAppointment;
           }
   
           public ObservableCollection<MedicalAppointment> MedicalAppointments { get; private set; }
           public ObservableCollection<MedicalAppointmentType> Labels { get; private set; }
   
   
           public ReceptionDeskData() {
               CreateLabels();
               CreateMedicalAppointments();
           }
       }
   }
   

   C#: ViewModel

   using System;
   using System.Collections.Generic;
   using System.ComponentModel;
   using SchedulerExample.Models;
   
   namespace SchedulerExample.ViewModels {
       public class ReceptionDeskViewModel : INotifyPropertyChanged {
           readonly ReceptionDeskData data;
   
           public event PropertyChangedEventHandler PropertyChanged;
           public DateTime StartDate { get { return ReceptionDeskData.BaseDate; } }
           public IReadOnlyList<MedicalAppointment> MedicalAppointments { get => data.MedicalAppointments; }
           public IReadOnlyList<MedicalAppointmentType> AppointmentTypes { get => data.Labels; }
   
           public ReceptionDeskViewModel() {
               data = new ReceptionDeskData();
           }
   
           protected void RaisePropertyChanged(string name) {
               if (PropertyChanged != null)
                   PropertyChanged(this, new PropertyChangedEventArgs(name));
           }
       }
   }
   

   XAML: View

   <ContentPage xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
               xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
               xmlns:local="clr-namespace:SchedulerExample"
               xmlns:dxsch="clr-namespace:DevExpress.Maui.Scheduler;assembly=DevExpress.Maui.Scheduler"
               xmlns:vm="clr-namespace:SchedulerExample.ViewModels"
               x:Class="SchedulerExample.MainPage">
       <ContentPage.BindingContext>
           <vm:ReceptionDeskViewModel/>
       </ContentPage.BindingContext>
       <dxsch:DayView>
           <dxsch:DayView.DataStorage>
               <dxsch:SchedulerDataStorage>
                   <dxsch:SchedulerDataStorage.DataSource>
                       <dxsch:DataSource AppointmentsSource="{Binding MedicalAppointments}"
                                         AppointmentLabelsSource="{Binding AppointmentTypes}">
                           <dxsch:DataSource.AppointmentMappings>
                               <dxsch:AppointmentMappings 
                                   Id="Id" 
                                   Start="StartTime" 
                                   End="EndTime" 
                                   Subject="Subject"
                                   LabelId="LabelId"
                                   Location="Location"/>
                           </dxsch:DataSource.AppointmentMappings>
                           <dxsch:DataSource.AppointmentLabelMappings>
                               <dxsch:AppointmentLabelMappings 
                                   Caption="Caption"
                                   Color="Color"
                                   Id="Id"/>
                           </dxsch:DataSource.AppointmentLabelMappings>
                       </dxsch:DataSource>
                   </dxsch:SchedulerDataStorage.DataSource>
               </dxsch:SchedulerDataStorage>
           </dxsch:DayView.DataStorage>
       </dxsch:DayView>
   </ContentPage>
   

Implements

INotifyPropertyChanged

IElementController

Inheritance

System.Object

BindableObject

Element

DevExpress.Maui.Core.Internal.DXElementBaseCore

DevExpress.Maui.Scheduler.Internal.SchedulerElement

DataSource

Extension Methods

Yield<DataSource>()

YieldIfNotNull<DataSource>()