[原译]C#制作进度窗体

2024-02-15 20:58

本文主要是介绍[原译]C#制作进度窗体,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

介绍

这是我在CodeProject上的第一篇文章。我希望对你有用

当我开发软件的时候。我通常因为一个很耗时是任务需要完成。而请求让用户等待,并且通过也允许用户取消。不论我做何种操作(比如下载文件。保存大文件等等)。我都需要做下面几件事:

  • 通过一个模态对话框来让用户等待操作完成
  • 能让用户看到进度。
  • 能让用户随时取消。

我搜了好久也没找到拿来就能用的窗体控件,也许是我没找到。于是我自己写。。
图1

背景

BackgroundWorker 类包含了我需要完成任务的所有东西。我只需要给他提供一个对话框。

使用代码

ProgressForm 包含了一个BackgroundWorker ,你要做的仅仅就是提供了一个完成工作的方法。

ProgressForm form = new ProgressForm();
form.DoWork += new ProgressForm.DoWorkEventHandler(form_DoWork);
//如果想为后台任务提供参数的话
form.Argument = something;

 

为了开始BackgroundWorker,只需要调用ShowDialog 方法。返回值则取决于任务是怎么完成的。

复制代码
DialogResult result = form.ShowDialog();
if (result == DialogResult.Cancel)
{
//用户点击了取消
}
else if (result == DialogResult.Abort)
{
/未处理的异常抛出
//你可以得到异常信息
MessageBox.Show(form.Result.Error.Message);
}
else if (result == DialogResult.OK)
{
//正常完成
//结果存储在 form.Result里
}
复制代码

 

 

最后。任务方法看起来是这样的。

复制代码
void form_DoWork(ProgressForm sender, DoWorkEventArgs e)
{
//得到参数
object myArgument = e.Argument;//做一些耗时的任务...
for (int i = 0; i < 100; i++)
{
//通知进度
sender.SetProgress(i, "Step " + i.ToString() + " / 100...");//...//检查是否点击了取消
if (sender.CancellationPending)
{
e.Cancel = true;
return;
}
}
}
复制代码

 

如果你想要改改进度条,或者进度条显示的文本。SetProgress 有一些重载的方法

public void SetProgress(string status);
public void SetProgress(int percent);
public void SetProgress(int percent, string status);

 

最后一个可自定义的字符串是:有两个预定义的字符串CancellingText 和DefaultStatusText. CancellingText ,这两个字符串,当用户点击取消的时候显示

如何实现
ProgressForm 紧紧嵌入了一个BackgroundWorker ,并包装进了主函数。

首先。我设计了如图所示的一个窗体,然后。添加了BackgroundWorker。

复制代码
public partial class ProgressForm : Form
{
public ProgressForm()
{
InitializeComponent();worker = new BackgroundWorker();
worker.WorkerReportsProgress = true;
worker.WorkerSupportsCancellation = true;
worker.DoWork += new System.ComponentModel.DoWorkEventHandler(worker_DoWork);
worker.ProgressChanged += new ProgressChangedEventHandler(
worker_ProgressChanged);
worker.RunWorkerCompleted += new RunWorkerCompletedEventHandler(
worker_RunWorkerCompleted);
}
void worker_DoWork(object sender, DoWorkEventArgs e)
{
}
void worker_ProgressChanged(object sender, ProgressChangedEventArgs e)
{
}
void worker_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
{
}
BackgroundWorker worker;
}
复制代码

我们必须把DoWork事件暴露给用户。我添加了一个委托。这样。我可以很容易的访问窗体成员

复制代码
public delegate void DoWorkEventHandler(ProgressForm sender, DoWorkEventArgs e);
public event DoWorkEventHandler DoWork;void worker_DoWork(object sender, DoWorkEventArgs e)
{
//后台任务开始
//调用用户的事件处理程序
if (DoWork != null)
DoWork(this, e);
}
复制代码

 

好。我们已经有了任务和事件。先爱。我们希望当窗体显示的时候。后台任务尽可能开始。我们在Load事件中写代码

复制代码
void ProgressForm_Load(object sender, EventArgs e)
{
worker.RunWorkerAsync();
}
现在写一个方法通知进度。添加代码到ProgressChanged 事件处理程序中public void SetProgress(int percent, string status)
{
worker.ReportProgress(percent, status);
}
void worker_ProgressChanged(object sender, ProgressChangedEventArgs e)
{
if (e.ProgressPercentage >= progressBar.Minimum &&
e.ProgressPercentage <= progressBar.Maximum)
{
progressBar.Value = e.ProgressPercentage;
}
if (e.UserState != null)
labelStatus.Text = e.UserState.ToString();
}
复制代码

 

我们快做好了。现在我们添加取消按钮

复制代码
void buttonCancel_Click(object sender, EventArgs e)
{
//通过worker我们要取消
worker.CancelAsync();
//使取消按钮不可用,改变状态文本
buttonCancel.Enabled = false;
labelStatus.Text = "Cancelling..."
}
最后一件事是我们想要当worker完成的时候自动关闭窗体,因为我们的worker通过ShowDialog 方法启动。如果直接接收返回结果会很好void worker_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
{
//ShowDialog返回值会指示worker是不是正确完成了
if (e.Error != null)
DialogResult = DialogResult.Abort;
else if (e.Cancelled)
DialogResult = DialogResult.Cancel;
else
DialogResult = DialogResult.OK;
//关闭窗体
Close();
}
复制代码

 

主要的工作就完成了。我添加了一些预定义的字符串啊。如果正在取消。保护状态不会改变。还有传递参数啊。
完整的代码如下:

复制代码
/// <summary>
/// 简单的进度窗体
/// </summary>
public partial class ProgressForm : Form
{
/// <summary>
/// 获得进度条以对他自定义
/// 在显示窗体之前.
/// 不要在后台任务中直接使用 !
/// </summary>
public ProgressBar ProgressBar { get { return progressBar; } }
/// <summary>
/// 传递给后台任务的参数.
/// </summary>
public object Argument { get; set; }
/// <summary>
/// 后台任务的结果.
///也可以检查ShowDialog返回值
///来看看是不是正确完成了.
/// </summary>public RunWorkerCompletedEventArgs Result { get; private set; }
/// <summary>
/// 如果点击了取消按钮则为true
///后台任务还在执行
/// </summary>
public bool CancellationPending
{
get { return worker.CancellationPending; }
}/// <summary>
/// 取消按钮被点击之后的显示文本
/// </summary>
public string CancellingText { get; set; }
/// <summary>
/// 缺省状态文本.
/// </summary>
public string DefaultStatusText { get; set; }
/// <summary>
/// DoWork事件的委托.
/// </summary>
/// <param name="sender">T事件源.</param>
/// <param name="e">包含事件数据.</param>
public delegate void DoWorkEventHandler(ProgressForm sender, DoWorkEventArgs e);
/// <summary>
/// 当后台任务开始的时候发生.
/// </summary>
public event DoWorkEventHandler DoWork;/// <summary>
/// 构造函数.
/// </summary>
public ProgressForm()
{
InitializeComponent();DefaultStatusText = "Please wait...";
CancellingText = "Cancelling operation...";worker = new BackgroundWorker();
worker.WorkerReportsProgress = true;
worker.WorkerSupportsCancellation = true;
worker.DoWork += new System.ComponentModel.DoWorkEventHandler(worker_DoWork);
worker.ProgressChanged += new ProgressChangedEventHandler(worker_ProgressChanged);
worker.RunWorkerCompleted += new RunWorkerCompletedEventHandler(
worker_RunWorkerCompleted);
}/// <summary>
/// 改变状态文本.
/// </summary>
/// <param name="status">新状态文本.</param>
public void SetProgress(string status)
{
//如果没有改变
//或者取消请求还在处理就不改变状态文本
if (status != lastStatus && !worker.CancellationPending)
{
lastStatus = status;
worker.ReportProgress(progressBar.Minimum - 1, status);
}
}
/// <summary>
///改变进度条的值
/// </summary>
/// <param name="percent">新值.</param>
public void SetProgress(int percent)
{
//如果值没有改变就不要更新进度条
if (percent != lastPercent)
{
lastPercent = percent;
worker.ReportProgress(percent);
}
}
/// <summary>
///改变进度条值和文本.
/// </summary>
/// <param name="percent">N新值.</param>
/// <param name="status">新文本.</param>
public void SetProgress(int percent, string status)
{
//如果至少一个改变就调用
if (percent != lastPercent || (status != lastStatus && !worker.CancellationPending))
{
lastPercent = percent;
lastStatus = status;
worker.ReportProgress(percent, status);
}
}private void ProgressForm_Load(object sender, EventArgs e)
{
//重用窗体,恢复缺省值
Result = null;
buttonCancel.Enabled = true;
progressBar.Value = progressBar.Minimum;
labelStatus.Text = DefaultStatusText;
lastStatus = DefaultStatusText;
lastPercent = progressBar.Minimum;
//窗体已载入就开始后台任务
worker.RunWorkerAsync(Argument);
}private void buttonCancel_Click(object sender, EventArgs e)
{
//通知后台任务,我们要取消
worker.CancelAsync();
//取消按钮不可用,改变文本
buttonCancel.Enabled = false;
labelStatus.Text = CancellingText;
}void worker_DoWork(object sender, DoWorkEventArgs e)
{
//后台任务开始
//调用用户的处理程序
if (DoWork != null)
DoWork(this, e);
}void worker_ProgressChanged(object sender, ProgressChangedEventArgs e)
{
//确保新值可用并更新
if (e.ProgressPercentage >= progressBar.Minimum &&
e.ProgressPercentage <= progressBar.Maximum)
{
progressBar.Value = e.ProgressPercentage;
}
//如果取消请求正在处理就不要更新
if (e.UserState != null && !worker.CancellationPending)
labelStatus.Text = e.UserState.ToString();
}void worker_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
{
//后台任务完成
//保持结果,关闭窗体
Result = e;
if (e.Error != null)
DialogResult = DialogResult.Abort;
else if (e.Cancelled)
DialogResult = DialogResult.Cancel;
else
DialogResult = DialogResult.OK;
Close();
}BackgroundWorker worker;
int lastPercent;
string lastStatus;
}
复制代码

 

结论
窗体简单,我通常用。希望对你们也有用

这篇关于[原译]C#制作进度窗体的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/712517

相关文章

2. c#从不同cs的文件调用函数

1.文件目录如下: 2. Program.cs文件的主函数如下 using System;using System.Collections.Generic;using System.Linq;using System.Threading.Tasks;using System.Windows.Forms;namespace datasAnalysis{internal static

C#实战|大乐透选号器[6]:实现实时显示已选择的红蓝球数量

哈喽,你好啊,我是雷工。 关于大乐透选号器在前面已经记录了5篇笔记,这是第6篇; 接下来实现实时显示当前选中红球数量,蓝球数量; 以下为练习笔记。 01 效果演示 当选择和取消选择红球或蓝球时,在对应的位置显示实时已选择的红球、蓝球的数量; 02 标签名称 分别设置Label标签名称为:lblRedCount、lblBlueCount

用命令行的方式启动.netcore webapi

用命令行的方式启动.netcore web项目 进入指定的项目文件夹,比如我发布后的代码放在下面文件夹中 在此地址栏中输入“cmd”,打开命令提示符,进入到发布代码目录 命令行启动.netcore项目的命令为:  dotnet 项目启动文件.dll --urls="http://*:对外端口" --ip="本机ip" --port=项目内部端口 例: dotnet Imagine.M

用Unity2D制作一个人物,实现移动、跳起、人物静止和动起来时的动画:中(人物移动、跳起、静止动作)

上回我们学到创建一个地形和一个人物,今天我们实现一下人物实现移动和跳起,依次点击,我们准备创建一个C#文件 创建好我们点击进去,就会跳转到我们的Vision Studio,然后输入这些代码 using UnityEngine;public class Move : MonoBehaviour // 定义一个名为Move的类,继承自MonoBehaviour{private Rigidbo

C# dateTimePicker 显示年月日,时分秒

dateTimePicker默认只显示日期,如果需要显示年月日,时分秒,只需要以下两步: 1.dateTimePicker1.Format = DateTimePickerFormat.Time 2.dateTimePicker1.CustomFormat = yyyy-MM-dd HH:mm:ss Tips:  a. dateTimePicker1.ShowUpDown = t

C#关闭指定时间段的Excel进程的方法

private DateTime beforeTime;            //Excel启动之前时间          private DateTime afterTime;               //Excel启动之后时间          //举例          beforeTime = DateTime.Now;          Excel.Applicat

C# 防止按钮botton重复“点击”的方法

在使用C#的按钮控件的时候,经常我们想如果出现了多次点击的时候只让其在执行的时候只响应一次。这个时候很多人可能会想到使用Enable=false, 但是实际情况是还是会被多次触发,因为C#采用的是消息队列机制,这个时候我们只需要在Enable = true 之前加一句 Application.DoEvents();就能达到防止重复点击的问题。 private void btnGenerateSh

C# double[] 和Matlab数组MWArray[]转换

C# double[] 转换成MWArray[], 直接赋值就行             MWNumericArray[] ma = new MWNumericArray[4];             double[] dT = new double[] { 0 };             double[] dT1 = new double[] { 0,2 };

PMBOK® 第六版 规划进度管理

目录 读后感—PMBOK第六版 目录 规划进度管理主要关注为整个项目期间的进度管理提供指南和方向。以下是两个案例,展示了进度管理中的复杂性和潜在的冲突: 案例一:近期,一个长期合作的客户因政策要求,急需我们为多家医院升级一个小功能。在这个过程中出现了三个主要问题: 在双方确认接口协议后,客户私自修改接口并未通知我们,直到催进度时才发现这个问题关于UI设计的部分,后台开发人员未将其传递给

C# Hash算法之MD5、SHA

MD5我们用的还是比较多的,一般用来加密存储密码。但是现在很多人觉MD5可能不太安全了,所以都用上了SHA256等来做加密(虽然我觉得都差不多,MD5还是能玩)。 还是跟上一篇说的一样,当一个算法的复杂度提高的同时肯定会带来效率的降低,所以SHA和MD5比较起来的话,SHA更安全,MD5更高效。 由于HASH算法的不可逆性,所以我认为MD5和SHA主要还是应用在字符串的"加密"上。 由于