SchedulerStorageBase.GetAppointments(DateTime, DateTime, 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 AppointmentBaseCollection GetAppointments(
    DateTime start,
    DateTime end,
    bool useCache = false
)

VB.NET

Public Function GetAppointments(
    start As Date,
    end As Date,
    useCache As Boolean = False
) As AppointmentBaseCollection

Parameters

Name	Type	Description
start	DateTime	A System.DateTime value that specifies the start time of the required time interval.
end	DateTime	A System.DateTime value that specifies the end time of the required time interval.

Optional Parameters

Name	Type	Default	Description
useCache	Boolean	False	True, to use the 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 standard appointments and occurrences (appointments created based upon recurring pattern appointments), 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.

Note

The end parameter’s value should be greater than or equal to the start parameter’s value, otherwise an exception will be thrown.

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.

Tip

In multi-threaded applications use the GetAppointments method with useCache parameter set to false

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetAppointments(DateTime, DateTime, 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-show-a-tooltip-in-the-datenavigator-control-e471/CS/Form1.cs#L54

SuperToolTip sTooltip1 = new SuperToolTip();
AppointmentBaseCollection abc = schedulerStorage2.GetAppointments(chi.HitDate, chi.HitDate.AddDays(1));

how-to-prompt-for-conflicts-when-dropping-an-appointment-e1590/CS/Form1.cs#L25

private bool IsIntersectingWithAnotherAppointment(DevExpress.XtraScheduler.Appointment appointment,DevExpress.XtraScheduler.ResourceIdCollection resourceIdCollection) {
    AppointmentBaseCollection abc = schedulerStorage1.GetAppointments(appointment.Start,appointment.End);
    return abc.Count>0? true:false;

how-to-bind-a-schedulerstorage-to-a-rangecontrol-e4093/CS/Form1.cs#L68

AppointmentBaseCollection appointments = schedulerStorage1.GetAppointments(start, end);

VB.NET

how-to-show-a-tooltip-in-the-datenavigator-control-e471/VB/Form1.vb#L49

Dim sTooltip1 As New SuperToolTip()
Dim abc As AppointmentBaseCollection = schedulerStorage2.GetAppointments(chi.HitDate, chi.HitDate.AddDays(1))

how-to-prompt-for-conflicts-when-dropping-an-appointment-e1590/VB/Form1.vb#L27

Private Function IsIntersectingWithAnotherAppointment(ByVal appointment As DevExpress.XtraScheduler.Appointment, ByVal resourceIdCollection As DevExpress.XtraScheduler.ResourceIdCollection) As Boolean
    Dim abc As AppointmentBaseCollection = schedulerStorage1.GetAppointments(appointment.Start,appointment.End)
    Return If(abc.Count>0, True, False)

how-to-bind-a-schedulerstorage-to-a-rangecontrol-e4093/VB/Form1.vb#L76

Dim appointments As AppointmentBaseCollection = schedulerStorage1.GetAppointments(start, [end])