SchedulerStorageBase.GetAppointments(TimeInterval, Boolean) Method

Retrieves the collection of appointments that fall within the specified time interval.

Namespace: DevExpress.XtraScheduler

Assembly: DevExpress.XtraScheduler.v18.2.Core.dll

Declaration

C#

public virtual AppointmentBaseCollection GetAppointments(
    TimeInterval interval,
    bool useCache = false
)

VB.NET

Public Overridable Function GetAppointments(
    interval As TimeInterval,
    useCache As Boolean = False
) As AppointmentBaseCollection

Parameters

Name	Type	Description
interval	TimeInterval	A TimeInterval object which is the required time interval.

Optional Parameters

Name	Type	Default	Description
useCache	Boolean	False	True, to use appointment cache to increase performance. When set to false, enables you to operate with SchedulerStorage in multiple threads, since different requests for appointments will not use the same cache.

Returns

Type	Description
AppointmentBaseCollection	An AppointmentBaseCollection collection of appointments which belong to the specified time interval.

Remarks

The GetAppointments method returns appointments of any type (regular appointments, recurring appointments and exceptions) that belong to the specified time interval. If an appointment’s time interval partially overlaps the specified interval, this appointment is also included in the collection returned.

The GetAppointments method gets appointments contained in the storage and passed through filters. Appointment filters are the AppointmentStorageBase.Filter property and the SchedulerStorageBase.FilterAppointment event.

By default, SchedulerControl creates a cache of the recently used appointments to increase performance. If you operate with recurrent appointments, occurrences for a certain pattern are generated only once and then cached to allow accessing them faster.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetAppointments(TimeInterval, Boolean) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-separate-shift-conflicted-appointments-while-dragging-another-appointment-e5007/CS/WindowsFormsApplication1/Form1.cs#L157

schedulerControl1.BeginUpdate();
AppointmentBaseCollection appointments = schedulerStorage1.GetAppointments(dragAppointmentInterval);
appointments.Sort(comparer);

how-to-export-appointments-with-custom-fields-to-vcalendar-format-e638/CS/VCalendarCustomFields/Form1.cs#L80

// !!! only first 3 days
IList appointments = schedulerStorage1.GetAppointments(new TimeInterval(now, now.AddDays(3)));

icalendar-export-import-of-appointments-in-the-specified-interval-containing-custom-objects-e547/CS/iCalendarExportImport/Form1.cs#L89

// Exporting 3 days only.
AppointmentBaseCollection appointments = schedulerStorage1.GetAppointments(new TimeInterval(now, now.AddDays(3)));

how-to-use-all-day-header-to-display-scheduled-time-statistics-e121/CS/Form1.cs#L38

TimeInterval interval = cell.Interval;
AppointmentBaseCollection apts = ((SchedulerControl)sender).Storage.GetAppointments(interval);
float percent = CalcCurrentWorkTimeLoad(apts, interval, resource);

how-to-calculate-and-display-totals-for-visible-appointments-e977/CS/Form1.cs#L80

private float CalcCurrentTotals(TimeInterval interval, Resource resource) {
    AppointmentBaseCollection apts = this.schedulerStorage1.GetAppointments(interval);
    float total = 0.0F;

VB.NET

how-to-separate-shift-conflicted-appointments-while-dragging-another-appointment-e5007/VB/WindowsFormsApplication1/Form1.vb#L148

schedulerControl1.BeginUpdate()
Dim appointments As AppointmentBaseCollection = schedulerStorage1.GetAppointments(dragAppointmentInterval)
appointments.Sort(comparer)

how-to-export-appointments-with-custom-fields-to-vcalendar-format-e638/VB/VCalendarCustomFields/Form1.vb#L86

' !!! only first 3 days
Dim appointments As IList = schedulerStorage1.GetAppointments(New TimeInterval(now, now.AddDays(3)))

icalendar-export-import-of-appointments-in-the-specified-interval-containing-custom-objects-e547/VB/iCalendarExportImport/Form1.vb#L91

' Exporting 3 days only.
Dim appointments As AppointmentBaseCollection = schedulerStorage1.GetAppointments(New TimeInterval(now, now.AddDays(3)))

how-to-use-all-day-header-to-display-scheduled-time-statistics-e121/VB/Form1.vb#L51

Private Function CalcCurrentWorkTimeLoad(ByVal interval As TimeInterval, ByVal resource As Resource) As Single
    Dim apts As AppointmentBaseCollection = Me.schedulerStorage1.GetAppointments(interval)
    Dim aptsByResource As New AppointmentBaseCollection()

how-to-calculate-and-display-totals-for-visible-appointments-e977/VB/Form1.vb#L82

Private Function CalcCurrentTotals(ByVal interval As TimeInterval, ByVal resource As Resource) As Single
    Dim apts As AppointmentBaseCollection = Me.schedulerStorage1.GetAppointments(interval)
    Dim total As Single = 0.0F