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

2024-02-15 20:58
文章标签 c# 制作 进度 .net 窗体 netcore 原译

本文主要是介绍[原译]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。

相关文章

如何使用C#串口通讯实现数据的发送和接收

如何使用C#串口通讯实现数据的发送和接收

《如何使用C#串口通讯实现数据的发送和接收》本文详细介绍了如何使用C#实现基于串口通讯的数据发送和接收,通过SerialPort类,我们可以轻松实现串口通讯,并结合事件机制实现数据的传递和处理,感兴趣... 目录1. 概述2. 关键技术点2.1 SerialPort类2.2 异步接收数据2.3 数据解析2.
阅读更多...
C#原型模式之如何通过克隆对象来优化创建过程

C#原型模式之如何通过克隆对象来优化创建过程

《C#原型模式之如何通过克隆对象来优化创建过程》原型模式是一种创建型设计模式,通过克隆现有对象来创建新对象,避免重复的创建成本和复杂的初始化过程,它适用于对象创建过程复杂、需要大量相似对象或避免重复初... 目录什么是原型模式？原型模式的工作原理C#中如何实现原型模式？1. 定义原型接口2. 实现原型接口3
阅读更多...
C# 委托中 Invoke/BeginInvoke/EndInvoke和DynamicInvoke 方法的区别和联系

C# 委托中 Invoke/BeginInvoke/EndInvoke和DynamicInvoke 方法的区别和联系

《C#委托中Invoke/BeginInvoke/EndInvoke和DynamicInvoke方法的区别和联系》在C#中,委托（Delegate）提供了多种调用方式,包括Invoke、Begi... 目录前言一、 Invoke方法1. 定义2. 特点3. 示例代码二、 BeginInvoke 和 EndI
阅读更多...
C#中的 Dictionary常用操作

C#中的 Dictionary常用操作

《C#中的Dictionary常用操作》C#中的DictionaryTKey,TValue是用于存储键值对集合的泛型类,允许通过键快速检索值,并且具有唯一键、动态大小和无序集合的特性,常用操作包括添... 目录基本概念Dictionary的基本结构Dictionary的主要特性Dictionary的常用操作
阅读更多...
C# winform操作CSV格式文件

C# winform操作CSV格式文件

《C#winform操作CSV格式文件》这篇文章主要为大家详细介绍了C#在winform中的表格操作CSV格式文件的相关实例,文中的示例代码讲解详细,感兴趣的小伙伴可以参考一下... 目录实例一实例效果实现代码效果展示实例二实例效果完整代码实例一实例效果当在winform界面中点击读取按钮时 将csv中
阅读更多...
C#集成DeepSeek模型实现AI私有化的流程步骤(本地部署与API调用教程)

C#集成DeepSeek模型实现AI私有化的流程步骤(本地部署与API调用教程)

《C#集成DeepSeek模型实现AI私有化的流程步骤(本地部署与API调用教程)》本文主要介绍了C#集成DeepSeek模型实现AI私有化的方法,包括搭建基础环境,如安装Ollama和下载DeepS... 目录前言搭建基础环境1、安装 Ollama2、下载 DeepSeek R1 模型客户端 ChatBo
阅读更多...
C# string转unicode字符的实现

C# string转unicode字符的实现

《C#string转unicode字符的实现》本文主要介绍了C#string转unicode字符的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随... 目录1. 获取字符串中每个字符的 Unicode 值示例代码：输出：2. 将 Unicode 值格式化
阅读更多...
C#中读取XML文件的四种常用方法

C#中读取XML文件的四种常用方法

《C#中读取XML文件的四种常用方法》Xml是Internet环境中跨平台的,依赖于内容的技术,是当前处理结构化文档信息的有力工具,下面我们就来看看C#中读取XML文件的方法都有哪些吧... 目录XML简介格式C#读取XML文件方法使用XmlDocument使用XmlTextReader/XmlTextWr
阅读更多...
C#比较两个List集合内容是否相同的几种方法

C#比较两个List集合内容是否相同的几种方法

《C#比较两个List集合内容是否相同的几种方法》本文详细介绍了在C#中比较两个List集合内容是否相同的方法,包括非自定义类和自定义类的元素比较,对于非自定义类,可以使用SequenceEqual、... 目录 一、非自定义类的元素比较1. 使用 SequenceEqual 方法（顺序和内容都相等）2.
阅读更多...
C#使用DeepSeek API实现自然语言处理,文本分类和情感分析

C#使用DeepSeek API实现自然语言处理,文本分类和情感分析

《C#使用DeepSeekAPI实现自然语言处理,文本分类和情感分析》在C#中使用DeepSeekAPI可以实现多种功能,例如自然语言处理、文本分类、情感分析等,本文主要为大家介绍了具体实现步骤,... 目录准备工作文本生成文本分类问答系统代码生成翻译功能文本摘要文本校对图像描述生成总结在C#中使用Deep
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2