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.v18.2.Web.dll

Declaration

C#

public event ConfigureDataReloadingTimeoutWebEventHandler ConfigureDataReloadingTimeout

VB.NET

Public Event ConfigureDataReloadingTimeout As ConfigureDataReloadingTimeoutWebEventHandler

Event Data

The ConfigureDataReloadingTimeout event's data class is ConfigureDataReloadingTimeoutWebEventArgs. 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:

C#

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

VB.NET

Private Sub Default_ConfigureDataReloadingTimeout(ByVal sender As Object, ByVal e As ConfigureDataReloadingTimeoutWebEventArgs)
  If e.DataSourceName = "sqlDataSource" Then
      e.DataReloadingTimeout = TimeSpan.FromSeconds(5)
  End If
End Sub

Related GitHub Examples

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

C#

aspnet-mvc-dashboard-how-to-obtain-data-for-web-dashboard-from-online-spreadsheets-t549666/CS/MvcDashboard/App_Start/DashboardConfig.cs#L38

DashboardConfigurator.Default.ExcelDataSourceBeforeFill += DefaultOnExcelDataSourceBeforeFill;
DashboardConfigurator.Default.ConfigureDataReloadingTimeout += (s, e) => {
    e.DataReloadingTimeout = TimeSpan.FromSeconds(30);