Dispatcher.Invoke Method (DispatcherPriority, Delegate)
Assembly: WindowsBase (in windowsbase.dll)
The priority, relative to the other pending operations in the Dispatcher event queue, the specified method is invoked.
A delegate to a method that takes no arguments, which is pushed onto the Dispatcher event queue.
Return ValueThe return value from the delegate being invoked or a null reference (Nothing in Visual Basic) if the delegate has no return value.
In WPF, only the thread which created a DispatcherObject may access that object. For example, a background thread which is spun off from the main UI thread cannot update the contents of a Button which was created on the UI thread. In order for the background thread to access the Content property of the Button, the background thread must delegate the work to the Dispatcher associated with the UI thread. This is accomplished by using either Invoke or BeginInvoke. Invoke is synchronous and BeginInvoke is asynchronous. The operation is added to the event queue of the Dispatcher at the specified DispatcherPriority.
Invoke is a synchronous operation; therefore, control will not return to the calling object until after the callback returns.
The following example places a delegate onto a Dispatcher at Normal using Invoke. For the full source of the sample, see Disable Command Source Via Dispatcher Timer Sample.
Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter EditionThe Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.