【C#】带等待窗体的BackgroundWorker

---------------201504170911更新---------------

更新内容：删除bgwUI新增的Start方法，改为通过new修饰符+可选参数的方式同时覆盖基类（BackgroundWorker）的RunWorkerAsync有参和无参俩方法。所以执行任务仍旧使用熟悉的RunWorkerAsync即可，忘掉蹩脚的Start。在此要感谢园友【新的开始】在评论中的指点，非常感谢！

---------------20150416原文（已更新）---------------

适用环境：.net 2.0+的Winform项目

这是上一篇【分享带等待窗体的任务执行器一枚】的姊妹篇，建议先看看那篇文章了解一下相关背景。这里简单介绍一下，两个方案的共同目的都是在执行耗时任务时向用户显示一个模式窗体（我称等待窗体），通过该窗体，任务可以向用户报告执行进度，用户也可以通过它干预任务的执行（也就是取消~如果任务允许被终止的话），等于就是在任务与用户之间通过一个等待窗体来进行信息传递。这样的需求应该是很常见的，注重用户体验的开发者都不可能让用户眼巴巴的面对一个卡死掉的界面，所以相信在类似场景中，大家都有各自的处理手段，例如异步执行任务，同时在业务窗体上弄个滚动条什么的，比如这样：

【C#】带等待窗体的BackgroundWorker

这样的手段有的猿友可能已经形成了很完善的通用方案，比我这个好上百倍都不止（在此也恳请路过老鸟不吝分享自己的或自己知道的现成好方案），有的猿友则可能还是具体情况具体处理，没有一个通用方案，而我在做的，就是把我的方案分享出来，让还没有类似轮子的猿友拿去后，经过简单处理就能实现效果，同时，也希望得到老鸟的指点，不断完善。

上一篇分享的是一个叫做WaitUI的执行器，可以执行任何方法，使用简单。而这一篇分享的是一个叫做BackgroundWorkerUI的东东（下文简称bgwUI），看名字就知道它是基于BackgroundWorker（下文可能简称bgw）组件实现的，所以如果你更习惯bgw的使用方式，这个适合你。先看一下使用效果：

【C#】带等待窗体的BackgroundWorker

功能：

在bgwUI执行任务期间（DoWork事件）显示一个等待窗体，任务执行完成后自动消失。任务执行完是指DoWork事件跑完，而不是RunWorkerCompleted事件完，也就是RunWorkerCompleted执行期间已经没有等待窗体了
等待窗体可以自定义，但须实现IWaitForm接口
在DoWork事件中可以访问一组bgwUI提供的属性和方法更新等待窗体上的文本和进度，以及可以控制等待窗体上的【取消】按钮是否可见。是的，更新控件不需要再用ProgressChanged事件，事实上等待窗体实例（一个IWaitForm实例）对调用者是隐藏的，你不能也不需要直接对它操作，一切通过bgwUI进行
如果任务允许被终止，即bgw.WorkerSupportsCancellation为true，等待窗体会显示【取消】按钮，用户可以通过点击它发出终止任务的请求，你可以像老样子一样，在DoWork中访问CancellationPending获知该请求
其余功能与bgw一致

使用示例：

private void button2_Click(object sender, EventArgs e)
{
    //构造函数的另一个重载可传入自定义等待窗体的实例
    using (BackgroundWorkerUI bgwUI = new BackgroundWorkerUI(/*new MyWaitForm()*/))
    {
        bgwUI.WorkerSupportsCancellation = true;//允许取消任务

        bgwUI.DoWork += bgwUI_DoWork;
        //bgwUI.ProgressChanged += bgwUI_ProgressChanged;//虽然不需要，但仍可注册ProgressChanged事件做其它事
        bgwUI.RunWorkerCompleted += bgwUI_RunWorkerCompleted;//亦可注册RunWorkerCompleted事件

        bgwUI.RunWorkerAsync();
    }
}

void bgwUI_DoWork(object sender, DoWorkEventArgs e)
{
    BackgroundWorkerUI bgwUI = sender as BackgroundWorkerUI;

    //可以通过bgwUI的一组公开属性和方法更新等待窗体
    //bgwUI.CancelControlVisible = true;//设置取消任务的控件的可见性，默认该属性会根据WorkerSupportsCancellation设置，但仍可以自由设置
    bgwUI.BarStyle = ProgressBarStyle.Continuous;//设置滚动条样式（默认是Marquee：循环梭动式）
    bgwUI.BarMaximum = 100;      //设置滚动条值上限（默认是100）
    bgwUI.BarMinimum = 0;        //设置滚动条值下限（默认是0）
    bgwUI.BarStep = 1;           //设置滚动条步进幅度（默认是10）
    bgwUI.BarVisible = true;     //设置滚动条是否可见（默认是true：可见）

    int i;
    for (i = Convert.ToInt32(e.Argument); i <= 100; i++)
    {
        if (bgwUI.CancellationPending)//老样子，访问CancellationPending获知用户是否取消任务
        {
            e.Cancel = true;
            return;
        }

        //更新等待窗体不需要调用ReportProgress()，也不需要WorkerReportsProgress支持
        bgwUI.WorkMessage = i.ToString();//设置任务进度描述
        bgwUI.BarValue = i;              //设置任务进度值

        //CancelControlVisible可以反复设置，不受WorkerSupportsCancellation限制
        //if (i % 10 == 0) { bgw.CancelControlVisible = false; }
        //else if (i % 5 == 0) { bgw.CancelControlVisible = true; }

        Thread.Sleep(50);
    }
    e.Result = i;
}

void bgwUI_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
{
    if (e.Cancelled)
    {
        MessageBox.Show("任务已取消！");
    }
    else if (e.Error != null)
    {
        MessageBox.Show("任务有异常！" + e.Error.Message);
    }
    else
    {
        MessageBox.Show("任务完成。" + e.Result);
    }
}

使用示例