DashboardViewer.UpdateExtractDataSourcesAsync(Action<String, ExtractUpdateResult>, Action<String, ExtractUpdateResult>) Method

Updates all extract data sources in the current dashboard asynchronously. Allows you to specify custom actions to perform after updating the data and file.

Namespace: DevExpress.DashboardWin

Assembly: DevExpress.Dashboard.v24.1.Win.dll

NuGet Package: DevExpress.Win.Dashboard

Declaration

C#

public Task UpdateExtractDataSourcesAsync(
    Action<string, ExtractUpdateResult> onDataUpdated,
    Action<string, ExtractUpdateResult> onFileUpdated
)

VB.NET

Public Function UpdateExtractDataSourcesAsync(
    onDataUpdated As Action(Of String, ExtractUpdateResult),
    onFileUpdated As Action(Of String, ExtractUpdateResult)
) As Task

Parameters

Name	Type	Description
onDataUpdated	Action<String, ExtractUpdateResult>	A custom action to perform when the data is updated.
onFileUpdated	Action<String, ExtractUpdateResult>	A custom action to perform when the file is updated.

Returns

Type	Description
Task	The task object that is the asynchronous operation to complete.

Example

View Example: WinForms - Dashboard with Extract Data Source

The following code snippet implements the UpdateExtractAsync method that updates all extract files bound to the dashboard. It displays a message box and reloads DashboardViewer’s data when data is updated, and displays a message box when the extract files are updated.

C#

delegate void SafeUpdate(string file);

private async void UpdateExtractAsync() {
    await dashboardViewer1.UpdateExtractDataSourcesAsync(
        (fileName, result) => { 
            OnDataReady(fileName); 
        },
        (fileName, result) => { 
            MessageBox.Show($"File {fileName} updated "); 
        });
}

void OnDataReady(string fileName) {
    dashboardViewer1.Invoke(new SafeUpdate(UpdateViewer), new object[] { fileName });
}
void UpdateViewer(string fileName) {
    MessageBox.Show($"Data for the file {fileName} is ready ");
    dashboardViewer1.ReloadData();
}

VB.NET

Private Delegate Sub SafeUpdate(ByVal file As String)

Private Sub UpdateExtractAsync()
    dashboardViewer1.UpdateExtractDataSourcesAsync(
        Sub(fileName, result)
            OnDataReady(fileName)
        End Sub,
        Sub(fileName, result)
            MessageBox.Show($"File {fileName} updated ")
        End Sub)
End Sub

Private Sub OnDataReady(ByVal fileName As String)
    dashboardViewer1.Invoke(New SafeUpdate(AddressOf UpdateViewer), New Object() {fileName})
End Sub
Private Sub UpdateViewer(ByVal fileName As String)
    MessageBox.Show($"Data for the file {fileName} is ready ")
    dashboardViewer1.ReloadData()
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the UpdateExtractDataSourcesAsync(Action<String, ExtractUpdateResult>, Action<String, ExtractUpdateResult>) 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-dashboard-extract-data-source/CS/ExtractDataSourceExample/Form1.cs#L44

private async void UpdateExtractAsync() {
    await dashboardViewer1.UpdateExtractDataSourcesAsync(
        (fileName, result) => {

VB.NET

winforms-dashboard-extract-data-source/VB/ExtractDataSourceExample/Form1.vb#L49

Private Sub UpdateExtractAsync()
    dashboardViewer1.UpdateExtractDataSourcesAsync(
        Sub(fileName, result)

Implements

UpdateExtractDataSourcesAsync(Action<String, ExtractUpdateResult>, Action<String, ExtractUpdateResult>)