The requested page is not available for the requested platform. You are viewing the content for Default platform.

DashboardConfigurator.ConfigureDataReloadingTimeout Event

Allows you to set a time interval that specifies how frequently the Web Dashboard should refill its in-memory cache when a user sends a data request.

Namespace: DevExpress.DashboardWeb

Assembly: DevExpress.Dashboard.v19.1.Web.dll

Declaration

public event ConfigureDataReloadingTimeoutWebEventHandler ConfigureDataReloadingTimeout
Public Event ConfigureDataReloadingTimeout As ConfigureDataReloadingTimeoutWebEventHandler

Event Data

The ConfigureDataReloadingTimeout event handler receives an argument of the ConfigureDataReloadingTimeoutWebEventArgs type. The following properties provide information specific to this event.

Property Description
DashboardId Gets the identifier of the current dashboard.
DataMember Gets the identifier of a corresponding data member in the data source.
DataReloadingTimeout Gets or sets a time interval that is the data reloading timeout.
DataSourceName Gets the data source name for which the event was raised.

Remarks

Important

To learn how to use the DashboardConfigurator's API, see the Server-Side API Overview topic.

The Web Dashboard allows you to set a time interval that specifies how frequently the Web Dashboard should refill its cache when a user sends a data request. Handle the ConfigureDataReloadingTimeout event to change this time interval.

For instance, if you set the ConfigureDataReloadingTimeoutWebEventArgs.DataReloadingTimeout event parameter to 100 seconds, the Web Dashboard updates the cache when a new request is received and the current cache version was created more than 100 seconds ago. The cached data is disposed of and new data is loaded instead.

To learn how the Web Dashboard manages its in-memory cache, see the following KB article: How to manage the Web Dashboard's in-memory data cache.

The following code snippet shows how to set a data reloading timeout for a specific data source:

private void Default_ConfigureDataReloadingTimeout(object sender, ConfigureDataReloadingTimeoutWebEventArgs e) {
  if (e.DataSourceName == "sqlDataSource") {
      e.DataReloadingTimeout = TimeSpan.FromSeconds(5);
  }            
}
See Also