首页 > 其他分享 >VS控件-BackgroundWorker

VS控件-BackgroundWorker

时间:2022-10-18 14:26:43浏览次数:49  
标签:控件 异步 DoWork bgWorker System BackgroundWorker VS 操作

 

 查询了一下MSDN文档,其中微软就BackgroundWorker类的功能有这么一个描述(英文的,根据个人理解翻译):BackgroundWorker类允许您在单独的线程上执行某个可能导致用户界面(UI)停止响应的耗时操作(比如文件下载数据库事务等),并且想要一个响应式的UI来反应当前耗时操作的进度。

可以看的出来,BackgroundWorker组件提供了一种执行异步操作(后台线程)的同时,并且还能妥妥的显示操作进度的解决方案。于是乎,我便深入的了解了一下BackgroundWorker类。针对BackgroundWorker类的部分重要属性和方法进行了一次总结。
属性:

WorkerReportsProgress
bool类型,指示BackgroundWorker是否可以报告进度更新。当该属性值为True是,将可以成功调用ReportProgress方法,否则将引发InvalidOperationException异常。
用法:
private BackgroundWorker bgWorker = new BackgroundWorker();
bgWorker.WorkerReportsProgress = true;
WorkerSupportsCancellation
bool类型,指示BackgroundWorker是否支持异步取消操作。当该属性值为True是,将可以成功调用CancelAsync方法,否则将引发InvalidOperationException异常。
用法:
bgWorker.WorkerSupportsCancellation = true;

CancellationPending
bool类型,指示应用程序是否已请求取消后台操作。此属性通常放在用户执行的异步操作内部,用来判断用户是否取消执行异步操作。当执行BackgroundWorker.CancelAsync()方法时,该属性值将变为True。
用法:
//在DoWork中键入如下代码
for (int i = 0; i <= 100; i++)
{
if (bgWorker.CancellationPending)
{
e.Cancel = true;
return;
}
else
{
bgWorker.ReportProgress(i,"Working");
System.Threading.Thread.Sleep(10);
}
}

IsBusy
bool类型,指示BackgroundWorker是否正在执行一个异步操作。此属性通常放在BackgroundWorker.RunWorkerAsync()方法之前,避免多次调用RunWorkerAsync()方法引发异常。当执行BackgroundWorker.RunWorkerAsync()方法是,该属性值将变为True。
//防止重复执行异步操作引发错误
if (bgWorker.IsBusy)
return;
bgWorker.RunWorkerAsync();

方法:

RunWorkerAsync()
开始执行一个后台操作。调用该方法后,将触发BackgroundWorker.DoWork事件,并以异步的方式执行DoWork事件中的代码。
该方法还有一个带参数的重载方法:RunWorkerAsync(Object)。该方法允许传递一个Object类型的参数到后台操作中,并且可以通过DoWork事件的DoWorkEventArgs.Argument属性将该参数提取出来。
注:当BackgroundWorker的IsBusy属性为True时,调用该方法将引发InvalidOperationException异常。
//在启动异步操作的地方键入代码
bgWorker.RunWorkerAsync("hello");

ReportProgress(Int percentProgress)
报告操作进度。调用该方法后,将触发BackgroundWorker. ProgressChanged事件。另外,该方法包含了一个int类型的参数percentProgress,用来表示当前异步操作所执行的进度百分比。
该方法还有一个重载方法:ReportProgress(Int percentProgress, Object userState)。允许传递一个Object类型的状态对象到 ProgressChanged事件中,并且可以通过ProgressChanged事件的ProgressChangedEventArgs.UserState属性取得参数值。
注:调用该方法之前需确保WorkerReportsProgress属性值为True,否则将引发InvalidOperationException异常。
用法:
for (int i = 0; i <= 100; i++)
{
//向ProgressChanged报告进度
bgWorker.ReportProgress(i,"Working");
System.Threading.Thread.Sleep(10);
}

CancelAsync()
请求取消当前正在执行的异步操作。调用该方法将使BackgroundWorker.CancellationPending属性设置为True。
但需要注意的是,并非每次调用CancelAsync()都能确保异步操作,CancelAsync()通常不适用于取消一个紧密执行的操作,更适用于在循环体中执行。
用法:
//在需要执行取消操作的地方键入以下代码
bgWorker.CancelAsync();

事件:

DoWork
用于承载异步操作。当调用BackgroundWorker.RunWorkerAsync()时触发。
需要注意的是,由于DoWork事件内部的代码运行在非UI线程之上,所以在DoWork事件内部应避免于用户界面交互,而于用户界面交互的操作应放置在ProgressChanged和RunWorkerCompleted事件中。

ProgressChanged
当调用BackgroundWorker.ReportProgress(int percentProgress)方式时触发该事件。
该事件的ProgressChangedEventArgs.ProgressPercentage属性可以接收来自ReportProgress方法传递的percentProgress参数值,ProgressChangedEventArgs.UserState属性可以接收来自ReportProgress方法传递的userState参数。

RunWorkerCompleted
异步操作完成或取消时执行的操作,当调用DoWork事件执行完成时触发。
该事件的RunWorkerCompletedEventArgs参数包含三个常用的属性Error,Cancelled,Result。其中,Error表示在执行异步操作期间发生的错误;Cancelled用于判断用户是否取消了异步操作;Result属性接收来自DoWork事件的DoWorkEventArgs参数的Result属性值,可用于传递异步操作的执行结果。

附源代码:

 

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using System.Windows.Forms;

namespace PrograssBar
{
public partial class PrograssBarUseBackgroundWorker : Form
{

private BackgroundWorker bgWorker = new BackgroundWorker();

public PrograssBarUseBackgroundWorker()
{
InitializeComponent();
InitializeBackgroundWorker();
}

private void InitializeBackgroundWorker()
{
bgWorker.WorkerReportsProgress = true;
bgWorker.WorkerSupportsCancellation = true;
bgWorker.DoWork += new DoWorkEventHandler(bgWorker_DoWork);
bgWorker.ProgressChanged += new ProgressChangedEventHandler(bgWorker_ProgessChanged);
bgWorker.RunWorkerCompleted += new RunWorkerCompletedEventHandler(bgWorker_WorkerCompleted);
}

private void btnStart_Click(object sender, EventArgs e)
{
if (bgWorker.IsBusy)
return;
this.progressBar1.Maximum = 100;
this.btnStart.Enabled = false;
this.btnStop.Enabled = true;
bgWorker.RunWorkerAsync("hello");
}

public void bgWorker_DoWork(object sender, DoWorkEventArgs e)
{
for (int i = 0; i <= 100; i++)
{
if (bgWorker.CancellationPending)
{
e.Cancel = true;
return;
}
else
{
bgWorker.ReportProgress(i,"Working");
System.Threading.Thread.Sleep(10);
}
}
}

public void bgWorker_ProgessChanged(object sender, ProgressChangedEventArgs e)
{
//string state = (string)e.UserState;//接收ReportProgress方法传递过来的userState
this.progressBar1.Value = e.ProgressPercentage;
this.label1.Text = "处理进度:" + Convert.ToString(e.ProgressPercentage) + "%";
}

public void bgWorker_WorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
{
if(e.Error!=null)
{
MessageBox.Show(e.Error.ToString());
return;
}
if (!e.Cancelled)
this.label1.Text = "处理完毕!";
else
this.label1.Text = "处理终止!";

}

private void btnStop_Click(object sender, EventArgs e)
{
this.btnStart.Enabled = true;
this.btnStop.Enabled = false;
bgWorker.CancelAsync();
}
}
}

 

标签:控件,异步,DoWork,bgWorker,System,BackgroundWorker,VS,操作
From: https://www.cnblogs.com/ZBO123/p/16802392.html

相关文章

  • vsftpd服务
    vsftpd服务ftp是互联网中进行文件传输的一种协议,基于C/S模式,FTP默认有两个工作端口(20数据传输,21FTP服务端就收客户端发来的指令和)安装FTP服务[root@haha-main-130~]#y......
  • PrograssBar控件
    常用属性:Value,Step,Style,MarqueeAnimationSpeed,Maximum,Minimum方法:PerformStep()Increment() 知识点1:Style控制PrograssBar的样式,选项为:Block,Continuous,Marquee当Style=Ma......
  • 解决 VS Code C/C++ 代码补全间歇性失效的问题
    最近一个月我的vscode突然开始发癫,正常情况下,在编辑器中输入一段字符应该会弹出自动补全的框框:但是不知道从何时起,我的vscode弹出的框里会出现只有C++关键字,没有任何库函......
  • 规则引擎深度对比,LiteFlow vs Drools!
    前言Drools是一款老牌的java规则引擎框架,早在十几年前,我刚工作的时候,曾在一家第三方支付企业工作。在核心的支付路由层面我记得就是用Drools来做的。难能可贵的是,Drools......
  • 界面控件DevExpress WinForm中文指南 - 使用HTML&CSS模板的条件样式
    DevExpressWinForm拥有180+组件和UI库,能为WindowsForms平台创建具有影响力的业务解决方案。DevExpressWinForms能完美构建流畅、美观且易于使用的应用程序,无论是Office......
  • github 上的vscode vim配置
    settins.json{ //Vim "vim.autoSwitchInputMethod.defaultIM":"normal", "vim.cursorStylePerMode.replace":"underline-thin", "vim.easymotion":true, "vim.ea......
  • 自己电脑上的vscode vim配置
    setting.json//vscode的vim配置"vim.easymotion":true,"vim.incsearch":true,"vim.leader":"<space>","vim.useSystemClipboard":true,"vim.useCtr......
  • VCL窗体和控件是如何实例化成对象运行的?
    VCL类库的窗体及每个控件都是一个类(比如TForm1、TButton),可以用类来创建一个对象,这个对象就可以运行了。C++Builder设计期新建的窗体及放置在窗体上的控件,IDE会自动创建窗......
  • LVS VS-TUN ipvsadm+heartbeat-ldirectord搭建linux集群
    ​测试环境一台调度机,两台真实机,使用ipvsadm+ldirectord搭建vs-tun的linux集群3台服务器都安装centos5.4调度机IP:eth0:192.168.11.10调度机VIP:eth0:0:192.168.11.20真实机1IP:e......
  • LVS VS-DR ipvsadm+heartbeat-ldirectord搭建linux集群
    ​测试环境一台调度机,两台真实机,使用ipvsadm+ldirectord搭建vs-tun的linux集群3台服务器都安装centos5.4调度机IP:eth0:192.168.1.210调度机VIP:eth0:0:192.168.1.219真实机1IP:e......