How do I update an ObservableCollection via a worker thread?

by

New option for .NET 4.5

Starting from .NET 4.5 there is a built-in mechanism to automatically synchronize access to the collection and dispatch CollectionChanged events to the UI thread. To enable this feature you need to call BindingOperations.EnableCollectionSynchronization from within your UI thread.

EnableCollectionSynchronization does two things:

  1. Remembers the thread from which it is called and causes the data binding pipeline to marshal CollectionChanged events on that thread.
  2. Acquires a lock on the collection until the marshalled event has been handled, so that the event handlers running UI thread will not attempt to read the collection while it’s being modified from a background thread.

Very importantly, this does not take care of everything: to ensure thread-safe access to an inherently not thread-safe collection you have to cooperate with the framework by acquiring the same lock from your background threads when the collection is about to be modified.

Therefore the steps required for correct operation are:

1. Decide what kind of locking you will be using

This will determine which overload of EnableCollectionSynchronization must be used. Most of the time a simple lock statement will suffice so this overload is the standard choice, but if you are using some fancy synchronization mechanism there is also support for custom locks.

2. Create the collection and enable synchronization

Depending on the chosen lock mechanism, call the appropriate overload on the UI thread. If using a standard lock statement you need to provide the lock object as an argument. If using custom synchronization you need to provide a CollectionSynchronizationCallback delegate and a context object (which can be null). When invoked, this delegate must acquire your custom lock, invoke the Action passed to it and release the lock before returning.

3. Cooperate by locking the collection before modifying it

You must also lock the collection using the same mechanism when you are about to modify it yourself; do this with lock() on the same lock object passed to EnableCollectionSynchronization in the simple scenario, or with the same custom sync mechanism in the custom scenario.

More Related Contents:

  1. ObservableCollection and threading [duplicate]
  2. Using BindingOperations.EnableCollectionSynchronization
  3. The calling thread cannot access this object because a different thread owns it
  4. How to use WPF Background Worker
  5. Change WPF controls from a non-main thread using Dispatcher.Invoke
  6. Difference between ObservableCollection and BindingList
  7. How to update GUI with backgroundworker?
  8. Execute task in background in WPF application
  9. How to update UI from another thread running in another class
  10. When to use BlockingCollection and when ConcurrentBag instead of List?
  11. Notify ObservableCollection when Item changes
  12. How to correctly implement a BackgroundWorker with ProgressBar updates?
  13. Accessing UI (Main) Thread safely in WPF
  14. How to create a task (TPL) running a STA thread?
  15. Task continuation on UI thread
  16. How do I sort an observable collection?
  17. The calling thread cannot access this object because a different thread owns it [duplicate]
  18. Updating an ObservableCollection in a separate thread
  19. The calling thread cannot access this object because a different thread owns it.WPF [duplicate]
  20. Can you access UI elements from another thread? (get not set)
  21. Calling async method on button click
  22. WPF UI multitasking
  23. Error: Must create DependencySource on same Thread as the DependencyObject even by using Dispatcher
  24. C# Threading/Async: Running a task in the background while UI is interactable
  25. WPF loading animation on a separate UI thread? (C#)
  26. How do you pass a BitmapImage from a background thread to the UI thread in WPF?
  27. ObservableCollection not updating View
  28. Returning from a task without blocking UI thread
  29. How to execute a method periodically from WPF client application using threading or timer [closed]
  30. Is it wrong to use the Dispatcher within my ViewModel?

Leave a Comment