C# control ToolStripProgressBar usage

C# ToolStripProgressBar usage analysis
It takes a long time in the process of processing, so I want to add a progress bar at the bottom of the form to indicate the progress of the processing process, I found that there is a magical control such as ToolStripProgressBar, which can be convenientUsed to reflect progress.But for how to use it, the first contact is quite confusing, so I habitually went to MSDN to find the official documentation.Sure enough, the official document gives a detailed routine, and the link is posted here: MSDN:
ToolStripProgressBar.
https://docs.microsoft.com/en-us/dotnet/api/system.windows.forms.toolstripprogressbar?redirectedfrom=MSDN&view=windowsdesktop-6.0

How to use
The ProgressBar control needs to be used in conjunction with a Class named BackgroundWorker.This class is a sub-thread that can work independently of the main thread. As long as the action that needs to be indicated by the progress bar is bound to this class, and the progress value of the progress bar is rewritten in real time according to the degree of completion, the progress bar can be realized.Synchronized display.It should be noted here that in order to reflect the progress of the work in real time, the WorkerReportsProgress property of the BackgroundWorker needs to be changed to True.
Mainly need to bind the following three events to BackgroundWorker:

The action to start work: DoWork
The action to complete the work: RunWorkerCompleted
The action to refresh during work: ProgressChanged
First, let's look at how to bind events, this part can be bound in the view designerIt can also be manually bound in the implemented code. Here is an example of manual binding in the code:

private void InitializeBackgroundWorker()
{
backgroundWorker1.DoWork += new DoWorkEventHandler(backgroundWorker1_DoWork);
backgroundWorker1.RunWorkerCompleted += new RunWorkerCompletedEventHandler(
backgroundWorker1_RunWorkerCompleted);
backgroundWorker1.ProgressChanged += new ProgressChangedEventHandler(
backgroundWorker1_ProgressChanged);
}
1
2
3
4
5
6
7
8
Start work DoWork
The function indicated by the progress bar needs to be bound here. It should be noted that the function needs to have two parameters for BackgroundWorker control. The worker parameter is used to restore the BackgroundWorker object, and the e parameter can indicate that the event that the action is completed isHow it is triggered (user canceled or action completed).Therefore, the function definition format should be as follows:

private void DoSomething(BackgroundWorker worker, DoWorkEventArgs e)
1
Two things need to be done in this action event: first, restore the worker; second, call the DoSomething function to start working.The code reference is as follows:

private void backgroundWorker1_DoWork(object sender, DoWorkEventArgs e)
{
//Restore worker object
BackgroundWorker worker = sender as BackgroundWorker;
//Start work
DoSomething(worker, e);
}
1
2
3
4
5
6
7
Finish the job RunWorkerCompleted
This is used to indicate how to do the next action when the job is finished.And you can distinguish whether the work is aborted or completed according to the incoming parameter e, so as to perform different "finishing" work.The code reference is as follows:

private void backgroundWorker1_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
{
//Restore the Worker object
BackgroundWorker worker = sender as BackgroundWorker;
//Determine whether an error caused an unexpected abort
if (e.Error != null)
{
//If an error occurs, the pop-up window will display the error message
MessageBox.Show(e.Error.Message);
}
//Determine whether the user cancels manually,If the program wants to support this function, it needs to have a cancel action in the program, and set e.cancel to true in this action
else if (e.Cancelled)
{
//Add the action that the user cancels manually
MessageBox.Show(“Canceled”);
}
//Judging whether it ends normally
else
{
//Add the closing action after the normal end
MessageBox.Show(“Complete”);
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
Refresh ProgressChanged at work
For the goal of adding a progress bar,Here, just update the progress value of the progress bar.Content that the user needs to refresh in real time during the process can also be added here.The code example is as follows:

private void backgroundWorker1_ProgressChanged(object sender,ProgressChangedEventArgs e)
{
//Update the progress value of the progress bar
this.toolStripProgressBar1.Value = e.ProgressPercentage;
}
1
2
3
4
5
Summary
Case Download
https://docs.microsoft.com/en-us/dotnet/api/system.componentmodel.backgroundworker?redirectedfrom=MSDN&view=net-6.0