C#•2y ago

✅ BackgroundWorker getting progress

I have a winform applications and with this I have put a ProgressBar on it. I was manually changing the progress inside functions using

progressBar.Value = <value>

progressBar.Value = <value>

but now that I run my functions in the background using BackgroundWorker, changing that progress is a little harder than I thought. If I am not mistaken the code below is defined as a 'Delegate Invocation' and I use it to run the function I would like to track progress of:

c#
public void ModifyTQWorker(object sender, DoWorkEventArgs e)
{
    try
    {
        object[] args = e.Argument as object[];
        if (args != null && args.Length == 4)
        {
            ClientContext context = args[0] as ClientContext;
            Microsoft.SharePoint.Client.List listObj = args[1] as Microsoft.SharePoint.Client.List;
            string TQNumber = args[2] as string;
            User Raisedby = args[3] as User;

            if (context != null && listObj != null && TQNumber != null && Raisedby != null)
            {
                (sender as BackgroundWorker).ReportProgress(10);
                ModifyTQ(context, listObj, TQNumber, Raisedby);
            }
            else
            {
                MessageBox.Show("One of the parameters was not given for the ModifyTQWorker.", "Error");
            }
        }
    }catch(Exception ex)
    {
        MessageBox.Show($"There was an issue modifying the current TQ.\n{ex.Message}", "Error");
    }
}

c#
public void ModifyTQWorker(object sender, DoWorkEventArgs e)
{
    try
    {
        object[] args = e.Argument as object[];
        if (args != null && args.Length == 4)
        {
            ClientContext context = args[0] as ClientContext;
            Microsoft.SharePoint.Client.List listObj = args[1] as Microsoft.SharePoint.Client.List;
            string TQNumber = args[2] as string;
            User Raisedby = args[3] as User;

            if (context != null && listObj != null && TQNumber != null && Raisedby != null)
            {
                (sender as BackgroundWorker).ReportProgress(10);
                ModifyTQ(context, listObj, TQNumber, Raisedby);
            }
            else
            {
                MessageBox.Show("One of the parameters was not given for the ModifyTQWorker.", "Error");
            }
        }
    }catch(Exception ex)
    {
        MessageBox.Show($"There was an issue modifying the current TQ.\n{ex.Message}", "Error");
    }
}

How can I give progress better?

leowest•4/3/24, 11:54 AM

Why harder?

leowest•4/3/24, 11:54 AM

The worker thread u pass the current progress value

leowest•4/3/24, 11:55 AM

i.e.:

Then on the report event u update the ui

leowest•4/3/24, 11:55 AM

leowest•4/3/24, 11:56 AM

there is a full sample here
https://learn.microsoft.com/en-us/dotnet/api/system.componentmodel.backgroundworker?view=net-8.0

Lleowest i.e.: ```cs worker.ReportProgress(value); ``` Then on the report event u update ...

XE SparkyCrackedOP•4/3/24, 12:13 PM

Thank you will try this

Lleowest there is a full sample here https://learn.microsoft.com/en-us/dotnet/api/system....

XE SparkyCrackedOP•4/3/24, 12:13 PM

And read this...I keep ignoring the documentation. My bad

jcotton42•4/3/24, 8:10 PM

you should not be using BackgroundWorker @SparkyCracked

jcotton42•4/3/24, 8:10 PM

you should instead use Task.Run, CancellationToken, and IProgress

jcotton42•4/3/24, 8:10 PM

https://blog.stephencleary.com/2013/05/taskrun-vs-backgroundworker-intro.html

Task.Run vs BackgroundWorker: Intro

This is an introductory post for a new series that I’ll be doing comparing BackgroundWorker to Task.Run (in an async style). I always recommend Task.Run, and I have already written a long post describing why, but I still see some developers resisting the New Way of Doing Things (TM). So this will be a short series where I’ll compare the code sid...

jcotton42•4/3/24, 8:10 PM

they're much nicer to use, and are applicable outside of GUIs

Jjcotton42 they're much nicer to use, and are applicable outside of GUIs

XE SparkyCrackedOP•4/4/24, 9:19 AM

Ok I see

XE SparkyCrackedOP•4/4/24, 9:20 AM

I think thats why I am having issues with my events as well.

XE SparkyCrackedOP•4/4/24, 9:20 AM

It's really killing me. Task.Run was so much better

Jjcotton42 you should not be using BackgroundWorker @SparkyCracked

XE SparkyCrackedOP•4/4/24, 9:22 AM

The main reason I use background worker in this case is just to understand it a little more as the company I am at used it in the code they wrote, and I wanted to see if it was useful.
I think imma try improve the existing code they have to instead of BGWorker

XE SparkyCrackedOP•4/4/24, 9:23 AM

Thanks for the help @jcotton42 and @leowest, let the learning continue :copium: