DashboardExtractDataSource.UpdateExtractFile(CancellationToken) Method

Updates a data extract file and allows you to cancel the update task through the use of a cancellation token.

Namespace: DevExpress.DashboardCommon

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

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

public void UpdateExtractFile(
    CancellationToken cancellationToken
)

VB.NET

Public Sub UpdateExtractFile(
    cancellationToken As CancellationToken
)

Parameters

Name	Type	Description
cancellationToken	CancellationToken	A CancellationToken object to monitor for cancellation requests.

Remarks

UpdateExtractFile accepts CancellationToken as a parameter and allows you to cancel the update operation in code. You can run the update operation in a separate thread (background task) and cancel this operation after a required period.

The following code snippet cancels the update operation after the set timeout limit expires:

C#

using System.Windows.Forms;
using System.Text;
using System.Threading.Tasks;
using System;
using DevExpress.DashboardCommon;

public partial class Form1 : DevExpress.XtraEditors.XtraForm {
    public Form1() {
        InitializeComponent();
    }
    private void simpleButton1_Click(object sender, System.EventArgs e) {
        CancellationTokenSource tokenSource = new CancellationTokenSource();
        CancellationToken updateExtractCT = tokenSource.Token;
        var updateExtractTask = Task.Factory.StartNew(() => {

            // Connect to the source database and create a data extract.
            DashboardExtractDataSource ExtractDatasource = new DashboardExtractDataSource();
            // ...
            ExtractDatasource.UpdateExtractFile(updateExtractCT);
        });
        try {
            var result = updateExtractTask.Wait(10000);
            if (result)
                MessageBox.Show("Update Completed");
            else {
                MessageBox.Show("Update Canceled");
                tokenSource.Cancel();
            }
        }
        catch (Exception ex) {
            MessageBox.Show(ex.InnerException.Message);
        }
        finally {
            tokenSource.Dispose();
        }
    }
}

VB.NET

Imports System
Imports System.Windows.Forms
Imports System.Threading
Imports System.Threading.Tasks
Imports DevExpress.DashboardCommon

Namespace ExtractDataSourceExample
    Partial Public Class Form1
        Inherits DevExpress.XtraEditors.XtraForm
        Public Sub New()
            InitializeComponent()
        End Sub

        Private Sub simpleButton1_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles simpleButton1.Click
            Dim tokenSource As New CancellationTokenSource()
            Dim updateExtractCT As CancellationToken = tokenSource.Token
            Dim updateExtractTask = Task.Factory.StartNew(Sub()
            ' Connect to the source database and create a data extract.
            Dim ExtractDatasource As New DashboardExtractDataSource()
            ' ...
            ExtractDatasource.UpdateExtractFile(updateExtractCT)
            End Sub)
            Try
                Dim result = updateExtractTask.Wait(10000)
                If result Then
                    MessageBox.Show("Update Completed")
                Else
                    MessageBox.Show("Update Canceled")
                    tokenSource.Cancel()
                End If


            Catch ex As Exception
                MessageBox.Show(ex.InnerException.Message)
            Finally
                tokenSource.Dispose()
            End Try
        End Sub
    End Class
End Namespace