Dispatcher.BeginInvoke Method (DispatcherPriority, Delegate)
Assembly: WindowsBase (in windowsbase.dll)
public DispatcherOperation BeginInvoke ( DispatcherPriority priority, Delegate method )
public function BeginInvoke ( priority : DispatcherPriority, method : Delegate ) : DispatcherOperation
The priority, relative to the other pending operations in the Dispatcher event queue, the specified method is invoked.
The delegate to a method that takes no arguments, which is pushed onto the Dispatcher event queue.
Return ValueAn object, which is returned immediately after BeginInvoke is called, that can be used to interact with the delegate as it is pending execution in the event queue.
If multiple BeginInvoke calls are made at the same DispatcherPriority, they will be executed in the order the calls were made.
BeginInvoke returns a DispatcherOperation object which can be used to interact with the delegate when the delegate is in the event queue.
The DispatcherOperation object returned by BeginInvoke can be used in several ways to interact with the specified delegate, such as:
Changing the DispatcherPriority of the delegate as it is pending execution in the event queue.
Removing the delegate from the event queue.
Waiting for the delegate to return.
Obtaining the value that the delegate returns after it is executed.
BeginInvoke is asynchronous; therefore, control returns immediately to the calling object after it is called.
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.
If BeginInvoke is called on a Dispatcher which has shut down, the status property of the returned DispatcherOperation is set to Aborted.
The following example shows how to place an operation onto a Dispatcher. For the full source code of this example, see the Single Threaded Application With Long Running Calculation sample.
First, a delegate is created that accepts no arguments.
Next, BeginInvoke is called. Since every DispatcherObject has a property which returns the Dispatcher it is associated with, the desired Dispatcher is obtained by querying the DispatcherObject, in this case a Button. The call to BeginInvoke takes two parameters: the priority, which is set Send, and the callback, which is passed in through an instance of the delegate nextPrimeDelegater.
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.