Back to Devexpress

SchedulerStorageBase.GetAppointments(TimeInterval, Boolean) Method

corelibraries-devexpress-dot-xtrascheduler-dot-schedulerstoragebase-dot-getappointments-x28-devexpress-dot-xtrascheduler-dot-timeinterval-system-dot-boolean-x29.md

latest3.4 KB
Original Source

SchedulerStorageBase.GetAppointments(TimeInterval, Boolean) Method

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

Namespace : DevExpress.XtraScheduler

Assembly : DevExpress.XtraScheduler.v25.2.Core.Desktop.dll

NuGet Package : DevExpress.Scheduler.CoreDesktop

Declaration

csharp
public virtual AppointmentBaseCollection GetAppointments(
    TimeInterval interval,
    bool useCache = false
)
vb
Public Overridable Function GetAppointments(
    interval As TimeInterval,
    useCache As Boolean = False
) As AppointmentBaseCollection

Parameters

NameTypeDescription
intervalTimeInterval

A TimeInterval object which is the required time interval.

|

Optional Parameters

NameTypeDefaultDescription
useCacheBooleanFalse

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

TypeDescription
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.

See Also

SchedulerStorageBase Class

SchedulerStorageBase Members

DevExpress.XtraScheduler Namespace