Async ShowDialog

Question

I'm using async/await to asynchronously load my data from database and during the loading process, I want to popup a loading form, it's just a simple form with running progress bar to indicate that there's a running process. After data has been loaded, the dialog will automatically be closed. How can I achieve that ? Below is my current code:

 protected async void LoadData() 
    {
       ProgressForm _progress = new ProgressForm();  
       _progress.ShowDialog()  // not working
       var data = await GetData();          
       _progress.Close();
    }

Updated:

I managed to get it working by changing the code:

 protected async void LoadData() 
        {
           ProgressForm _progress = new ProgressForm();  
           _progress.BeginInvoke(new System.Action(()=>_progress.ShowDialog()));
           var data = await GetData();          
           _progress.Close();
        }

Is this the correct way or there's any better ways ?

Thanks for your help.

Answer 1

It's easy to implement with Task.Yield, like below (WinForms, no exception handling for simplicity). It's important to understand how the execution flow jumps over to a new nested message loop here (that of the modal dialog) and then goes back to the original message loop (that's what await progressFormTask is for):

namespace WinFormsApp
{
  internal static class DialogExt
  {
    public static async Task<DialogResult> ShowDialogAsync(this Form @this)
    {
      await Task.Yield();
      if (@this.IsDisposed)
        return DialogResult.Cancel;
      return @this.ShowDialog();
    }
  }

  public partial class MainForm : Form
  {
    public MainForm()
    {
      InitializeComponent();
    }

    async Task<int> LoadDataAsync()
    {
      await Task.Delay(2000);
      return 42;
    }

    private async void button1_Click(object sender, EventArgs e)
    {
      var progressForm = new Form() { 
        Width = 300, Height = 100, Text = "Please wait... " };

      object data;
      var progressFormTask = progressForm.ShowDialogAsync();
      try 
      {
        data = await LoadDataAsync();
      }
      finally 
      {
        progressForm.Close();
        await progressFormTask;
      }

      // we got the data and the progress dialog is closed here
      MessageBox.Show(data.ToString());
    }
  }
}

Answer 2

Here's a pattern that uses Task.ContinueWith and should avoid any race condition with your use of the modal ProgressForm:

protected async void LoadDataAsync()
{
    var progressForm = new ProgressForm();

    // 'await' long-running method by wrapping inside Task.Run
    await Task.Run(new Action(() =>
    {
        // Display dialog modally
        // Use BeginInvoke here to avoid blocking
        //   and illegal cross threading exception
        this.BeginInvoke(new Action(() =>
        {   
            progressForm.ShowDialog();
        }));
        
        // Begin long-running method here
        LoadData();
    })).ContinueWith(new Action<Task>(task => 
    {
        // Close modal dialog
        // No need to use BeginInvoke here
        //   because ContinueWith was called with TaskScheduler.FromCurrentSynchronizationContext()
        progressForm.Close();
    }), TaskScheduler.FromCurrentSynchronizationContext());
}

Answer 3

ShowDialog() is a blocking call; execution will not advance to the await statement until the dialog box is closed by the user. Use Show() instead. Unfortunately, your dialog box will not be modal, but it will correctly track the progress of the asynchronous operation.

Answer 4

Always call ShowDialog(), LoadDataAsync and Close() in order to avoid IsDisposed as in @noseratio 's answer. So use Task.Yield() to delay LoadDataAsync() and not ShowDialog()

public partial class Form1 : Form
{
    public Form1()
    {
        InitializeComponent();
    }
    async Task<int> LoadDataAsync()
    {
        Console.WriteLine("Load");
        await Task.Delay(2000);
        return 42;
    }

    private async void button1_Click(object sender, EventArgs e)
    {
        var progressForm = new Form()
        {
            Width = 300,
            Height = 100,
            Text = "Please wait... "
        };

        async Task<int> work()
        {
            try
            {
                await Task.Yield();
                return await LoadDataAsync();
            }
            finally
            {
                Console.WriteLine("Close");
                progressForm.Close();
            }
        }
        var task = work();
        Console.WriteLine("ShowDialog");
        progressForm.ShowDialog();
        object data = await task;

        // we got the data and the progress dialog is closed here
        Console.WriteLine("MessageBox");
        MessageBox.Show(data.ToString());
    }
}

Answer 5

You could try the following:

protected async void LoadData()
{
    ProgressForm _progress = new ProgressForm();
    var loadDataTask = GetData();
    loadDataTask.ContinueWith(a =>
        this.Invoke((MethodInvoker)delegate
        {
            _progress.Close();
        }));
    _progress.ShowDialog();
}