Using the C# Dispatcher in WPF Applications

by

Your app has a main UI thread (usually ManagedThreadId==1). Typically in a chat app your events will come in on other threads (either dedicated socket listen threads or thread pool threads from listening code). If you want to update the UI from an event that gets pull on some other thread you must use the dispatcher. A useful test here is the Dispatcher.CheckAccess() method that returns true if code is on UI thread and false if on some other thread. A typical call looks something like: 

using System.Windows.Threading; // For Dispatcher.

if (Application.Current.Dispatcher.CheckAccess()) {
    network_links.Add(new NetworkLinkVM(link, start_node, end_node));
}
else {
    Application.Current.Dispatcher.BeginInvoke(DispatcherPriority.Normal, new Action(()=>{
        network_links.Add(new NetworkLinkVM(link, start_node, end_node));
    }));
}

If you’re in the main window you can use:

Dispatcher.BeginInvoke(...

If you’re in someother context eg a view model then use:

Application.Current.Dispatcher.BeginInvoke(

Invoke vs BeginInvoke
Use Invoke if you want the current thread to wait until the UI thread has processed the dispatch code or BeginInvoke if you want current thread to continue without waiting for operation to complete on UI thread.

MessageBox, Dispatchers and Invoke/BeginInvoke:
Dispatcher.Invoke will block your thread until the MessageBox is dismissed.
Dispatcher.BeginInvoke will allow your thread code to continue to execute while the UI thread will block on the MessageBox call until its dismissed.

CurrentDispatcher vs Current.Dispatcher!
Be ware of Dispatcher.CurrentDispatcher as my understanding of this is that is will return a Dispatcher for the current thread not the UI thread. Generally are you interested in the dispatcher on the UI thread – Application.Current.Dispatcher always returns this.

Additional note:
If you are finding you are having to check dispatcher CheckAccess often then a useful helper method is: 

public void DispatchIfNecessary(Action action) {
    if (!Dispatcher.CheckAccess())
        Dispatcher.Invoke(action);
    else
        action.Invoke();
}

Which can be called as:

DispatchIfNecessary(() => {
    network_links.Add(new NetworkLinkVM(link, start_node, end_node));
});

More Related Contents:

  1. Change WPF controls from a non-main thread using Dispatcher.Invoke
  2. How to put delay before doing an operation in WPF
  3. Using the WPF Dispatcher in unit tests
  4. The calling thread cannot access this object because a different thread owns it.WPF [duplicate]
  5. Dispatcher Invoke(…) vs BeginInvoke(…) confusion
  6. WPF Dispatcher {“The calling thread cannot access this object because a different thread owns it.”}
  7. WPF MVVM navigate views
  8. Delete a file being used by another process
  9. Accessing UI (Main) Thread safely in WPF
  10. Metadata file ‘.dll’ could not be found
  11. In my WPF application, my loaded PNG logo in image shows at design time but not at run time
  12. Options for embedding Chromium instead of IE WebBrowser control with WPF/C# [closed]
  13. Close Window from ViewModel [duplicate]
  14. How to render a WPF UserControl to a bitmap without creating a window
  15. How to write a ViewModelBase in MVVM
  16. WPF C#: Rearrange items in listbox via drag and drop
  17. Use StringFormat to add a string to a WPF XAML binding
  18. Set focus on textbox in WPF
  19. Invoking methods with optional parameters through reflection
  20. How can I set the color of a selected row in DataGrid
  21. WPF Error 40 BindingExpression path error: property not found on ‘object’
  22. Accessing properties through Generic type parameter
  23. Should I bind to ICollectionView or ObservableCollection
  24. Mutually exclusive checkable menu items?
  25. Programmatically changing button icon in WPF
  26. WPF TextBlock highlight certain parts based on search condition
  27. Get selected value from combo box in C# WPF
  28. How does one “disable” a button in WPF using the MVVM pattern?
  29. WPF – converting Bitmap to ImageSource
  30. WPF – Remove focus when clicking outside of a textbox

Leave a Comment