SchedulerStorageBase.GetAppointments(DateTime, DateTime, Boolean) Method

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

Namespace: DevExpress.XtraScheduler

Assembly: DevExpress.XtraScheduler.v20.1.Core.dll

Declaration

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

See Also