SchedulerDataStorage.FetchAppointments Event
Occurs before the SchedulerDataStorage starts retrieving the appointments for the specified time interval.
Namespace: DevExpress.XtraScheduler
Assembly: DevExpress.XtraScheduler.v24.1.dll
NuGet Package: DevExpress.Win.Scheduler
Declaration
Event Data
The FetchAppointments event's data class is FetchAppointmentsEventArgs. The following properties provide information specific to this event:
| Property | Description |
|---|---|
| ForceReloadAppointments | Gets or sets whether the appointments collection should be reloaded after handling the SchedulerStorageBase.FetchAppointments event. |
| Interval | Gets the time interval which the event was raised for. Inherited from TimeIntervalEventArgs. |
Remarks
Handle the FetchAppointments event to limit the number of appointments fetched from the data source. This can be useful when working with a large amount of data, and only a small part of it needs to be loaded at one time.
The FetchAppointments event reduces the amount of data fetched from slow data sources with large data sets. Consider the interaction between the Scheduler, the Storage and the Data Source. When the Scheduler changes its displayed time interval, it requests the Storage for appointments to display. The Storage generates the FetchAppointments event and queries the Data Source for more data. This query may result in sending an excessive amount of appointment data. To prevent this, and to get only data that is required for the visible time interval, you can handle the FetchAppointment event. In the event handler, you should modify the query to get only the required data.
If the FetchAppointments event is handled, the Scheduler does not rely on its own built-in caching strategy. The FetchAppointments event occurs in situations that do not involve any changes in displayed data, such as control resizing. To improve performance, treat these cases as your needs dictate and decide for yourself whether appointment data should be queried again or remain intact.
Certain scenarios may benefit from testing the ISchedulerStateService.IsDataRefreshAllowed property before fetching data in the FetchAppointments event handler and perform the operation only if its value is true. In general, it is not required.
The following requirements should be met when handling the FetchAppointments event:
- Do not clear and populate SchedulerDataStorage.Appointments collection items within the FetchAppointments event handler because this event was specially created to minimize the load time in databound mode, by loading only visible appointments. It occurs before the SchedulerDataStorage starts to retrieve the appointments for the specified time interval, and allows you to modify the data source using the e.Interval property value as a query parameter. If appointments are generated within the FetchAppointments event handler, you may fail to retrieve custom fields when appointments are being displayed, because appointment data is disposed of. That is, it’s not suitable for unbound mode.
- Establish a mapping for the Appointment.Id property value using the AppointmentMappingInfo.AppointmentId property. This is required for correct appointment resizing beyond the visible interval when handling the FetchAppointments event.
To pad the time interval used to query appointments, we use a range of seven days (PADDING_DAYS constant). You can specify another interval arbitrarily.
void schedulerStorage1_FetchAppointments(object sender, FetchAppointmentsEventArgs e) {
ResourceBaseCollection resourcesVisible = schedulerControl1.ActiveView.GetResources();
var differentResources = resourcesVisible.Except(lastQueriedResources);
// If a different resource is displayed or the visible time interval intersects the time interval used in a recent query, fetch the data.
if ((differentResources.Count() != 0) || (e.Interval.Start < lastQueriedTimeInterval.Start) || (e.Interval.End > lastQueriedTimeInterval.End)) {
QueryAppointmentDataSource(e, resourcesVisible);
lastQueriedResources = resourcesVisible;
lastQueriedTimeInterval = e.Interval;
}
}
private void QueryAppointmentDataSource(FetchAppointmentsEventArgs e, ResourceBaseCollection resources) {
string resListString = String.Join(",", resources.Select(res => res.Id.ToString()));
// Modify the FillBy query to fetch appointments only for the specified resources.
appointmentsTableAdapter.Commands[1].CommandText =
String.Format("SELECT Appointments.* FROM Appointments WHERE (OriginalOccurrenceStart <= @end AND OriginalOccurrenceEnd >= @start) OR (EndTime >= @start AND StartTime <= @end)", resListString);
appointmentsTableAdapter.FillBy(this.scheduleTestDataSet.Appointments, e.Interval.Start.AddDays(-PADDING_DAYS), e.Interval.End.AddDays(PADDING_DAYS));
queryExecutionCounter++;
}
Note
Prior to v15.2, the FetchAppointments event occurs in situations that do not involve any changes in displayed data ranges. This behavior may result in unhandled exceptions if the event was not properly handled. To solve the problem, we have implemented additional internal criteria that should be met before the event is raised. Starting with v15.2, the FetchAppointments event does not fire as often as it did before and does not fire at all in certain situations. This behavior may affect the customer’s application logic. If you experience unwanted side effects due to the newly introduced behavior, set the SchedulerDataStorage.EnableSmartFetch option to false to revert to the former mechanism of raising the FetchAppointments event.
Important
When the DateNavigator.BoldAppointmentDates property is set to true, the DateNavigator requests appointment information to highlight the corresponding dates. As a result, the Date Navigator control linked with the Scheduler control can cause multiple FetchAppointments events to occur. In this case, the e.Interval property returns the interval displayed in the DateNavigator.
See the FetchAppointments Event - Handling Large Datasets document for more information.
Related GitHub Examples
The following code snippet (auto-collected from DevExpress Examples) contains a reference to the FetchAppointments event.
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.