SchedulerDataStorage.RefreshData() Method

Updates Scheduler to reflect any changes made in the data sources which store the appointments and appointment resources.

Namespace: DevExpress.XtraScheduler

Assembly: DevExpress.XtraScheduler.v24.1.dll

NuGet Package: DevExpress.Win.Scheduler

Declaration

C#

public void RefreshData()

VB.NET

Public Sub RefreshData

Remarks

Appointments and appointment resources for the XtraScheduler control can be stored in external data sources. To connect the XtraScheduler control to these data sources, use the DataSource and DataMember properties of the Appointments and Resources objects.

By default, data from the data sources is automatically reloaded after each change is made to the data sources (for instance, when records are added, deleted or modified). Automatic data reloading can be disabled via the PersistentObjectStorage<T>.AutoReload properties of the AppointmentStorageBase and ResourceStorageBase objects. If this property is set to false, the XtraScheduler control ignores any change notifications sent by the data source, and doesn’t automatically reload data. You need to manually call the RefreshData method to reload the data in the data source for the changes to appear in the XtraScheduler control.

Note

When you call the RefreshData method, all appointments in the Scheduler are recreated. So, all appointments referenced in your code before become disposed and you should not use them.

Note for VB.NET users: an appointment, newly created via the SchedulerDataStorage.CreateAppointment method has its PersistentObject.CustomFields values set to Nothing. However after calling the RefreshData method, which loads data from the data source, the appointment custom field values are set to the values of the mapped data fields. If the data field does not contain any value, then the corresponding custom field value becomes DBNull instead of Nothing.

Important

We always recommend testing the ISchedulerStateService.IsDataRefreshAllowed property before manually executing the SchedulerDataStorage.RefreshData or SchedulerControl.RefreshData methods.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the RefreshData() 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#

winforms-scheduler-manage-resources-runtime/CS/SchedulerResourcesManagement/Form1.cs#L75

schedulerStorage1.Resources.Add(resource);
schedulerStorage1.RefreshData();
ScrollToLastResource();

VB.NET

winforms-scheduler-manage-resources-runtime/VB/SchedulerResourcesManagement/Form1.vb#L78

schedulerStorage1.Resources.Add(resource)
schedulerStorage1.RefreshData()
ScrollToLastResource()