SchedulerStorageBase.GetAppointments(TimeIntervalCollection, Boolean) Method

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

Namespace: DevExpress.XtraScheduler

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

Declaration

C#

public AppointmentBaseCollection GetAppointments(
    TimeIntervalCollection intervals,
    bool useCache = false
)

VB.NET

Public Function GetAppointments(
    intervals As TimeIntervalCollection,
    useCache As Boolean = False
) As AppointmentBaseCollection

Parameters

Name	Type	Description
intervals	TimeIntervalCollection	A TimeIntervalCollection object whose Start and End members identify 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.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetAppointments(TimeIntervalCollection, 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#

printing-appointment-details-using-the-xtrareports-suite-e1183/CS/PrintingViaReports/Form1.cs#L103

schedulerControl1.Start = DateTime.Now;
AppointmentBaseCollection abc = schedulerStorage1.GetAppointments(schedulerControl1.ActiveView.GetVisibleIntervals());
if (abc.Count > 0)

how-to-print-visible-appointments-in-the-xtrareport-e1068/CS/WindowsApplication1/Form1.cs#L22

XtraReport1 r = new XtraReport1();
r.DataSource = schedulerStorage1.GetAppointments(schedulerControl1.ActiveView.GetVisibleIntervals());
ReportPrintTool rpt = new ReportPrintTool(r);

how-to-emulate-the-calendar-detail-style-printout-by-using-the-xtrareports-suite-e20057/CS/B186127/Form1.cs#L27

private void simpleButton1_Click(object sender, EventArgs e) {
    AppointmentBaseCollection aptCollection = schedulerStorage1.GetAppointments(schedulerControl1.ActiveView.GetVisibleIntervals());

VB.NET

printing-appointment-details-using-the-xtrareports-suite-e1183/VB/PrintingViaReports/Form1.vb#L94

schedulerControl1.Start = Date.Now
Dim abc As AppointmentBaseCollection = schedulerStorage1.GetAppointments(schedulerControl1.ActiveView.GetVisibleIntervals())
If abc.Count > 0 Then

how-to-print-visible-appointments-in-the-xtrareport-e1068/VB/WindowsApplication1/Form1.vb#L20

Dim r As New XtraReport1()
r.DataSource = schedulerStorage1.GetAppointments(schedulerControl1.ActiveView.GetVisibleIntervals())
Dim rpt As New ReportPrintTool(r)

how-to-emulate-the-calendar-detail-style-printout-by-using-the-xtrareports-suite-e20057/VB/B186127/Form1.vb#L29

Private Sub simpleButton1_Click(ByVal sender As Object, ByVal e As EventArgs) Handles simpleButton1.Click
    Dim aptCollection As AppointmentBaseCollection = schedulerStorage1.GetAppointments(schedulerControl1.ActiveView.GetVisibleIntervals())