Using SynchronizationContext in Windows Forms

Posted by Anuraj on Friday, March 22, 2013

.Net .Net 3.0 / 3.5 CodeProject Windows Forms

Long back I wrote a post about how to fix - System.InvalidOperationException – Cross-thread operation not valid exception, while we try to access user interface elements from a different thread, other than the thread(normally main thread), which created the user interface elements. .NET 2.0 brings us SynchoronizationContext which allows us to execute a section of code in the UI context (the thread that created the UI). Also, it allows us to specify if the background thread will block waiting for the UI thread (using Send) or will not block (using Post). SynchoronizationContext class can be used in Windows Forms, WPF, and ASP.Net etc. For Windows forms, you can get the UI context from the WindowsFormsSynchronizationContext.Current property. For WPF, the implementation is DispatcherSynchronizationContext class.

In the following example, I am updating the UI from a separate thread, without the _synchronizationContext.Post() method, it will throw an InvalidOperationException. Here is the implementation.

private ThreadStart _threadStart;
private Thread _thread;
private SynchronizationContext _synchronizationContext;

private void Form1_Load(object sender, EventArgs e)
{
    _synchronizationContext = 
        WindowsFormsSynchronizationContext.Current;
    _threadStart = new ThreadStart(LongProcess);
    _thread = new Thread(_threadStart);
    _thread.Start();
}

private void LongProcess()
{
    for (int i = 0; i < 100; i++)
    {
        Thread.Sleep(100);
        _synchronizationContext.Post(
            (o) => textBox1.Text = i.ToString(), null);
    }
}

When the value is assigned to textbox, if you look the threads window, you can find, it is running under main thread.

Threads window - UI thread

You can find more details about WindowsFormsSynchronizationContext class in MSDN



Did you like this article? Share it with your friends

Facebook Twitter Google+ LinkedIn Reddit StumbleUpon



MVP
Subscribe
Archives


Copyright © 2017 - Anuraj P. Blog content licensed under the Creative Commons CC BY 2.5 | Unless otherwise stated or granted, code samples licensed under the MIT license. This is a personal blog. The opinions expressed here represent my own and not those of my employer. Hosted with ❤ by GitHub