This documentation is archived and is not being maintained.

Dispatcher.BeginInvoke Method (DispatcherPriority, Delegate, Object)

Executes the specified delegate asynchronously at the specified priority and with the specified argument on the thread the Dispatcher is associated with.

Namespace: System.Windows.Threading
Assembly: WindowsBase (in windowsbase.dll)

public DispatcherOperation BeginInvoke (
	DispatcherPriority priority,
	Delegate method,
	Object arg
)
public DispatcherOperation BeginInvoke (
	DispatcherPriority priority, 
	Delegate method, 
	Object arg
)
public function BeginInvoke (
	priority : DispatcherPriority, 
	method : Delegate, 
	arg : Object
) : DispatcherOperation
You cannot use methods in XAML.

Parameters

priority

The priority, relative to the other pending operations in the Dispatcher event queue, the specified method is invoked.

method

A delegate to a method that takes one argument, which is pushed onto the Dispatcher event queue.

arg

The object to pass as an argument to the specified method.

Return Value

An 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.

Exception typeCondition

ArgumentNullException

method is a null reference (Nothing in Visual Basic).

InvalidEnumArgumentException

priority is not a valid DispatcherPriority.

Arg can be a null reference (Nothing in Visual Basic) if no arguments are needed.

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 multiple BeginInvoke calls are made at the same DispatcherPriority, they will be executed in the order the calls were made.

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 Weather Service Simulation Via Dispatcher sample.

First, a delegate is created which accepts one argument, in this case a string.

private delegate void OneArgDelegate(String arg);

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 Grid named tomorrowsWeather. The call to BeginInvoke takes three parameters: the priority, which is set Send, the callback, which is passed in through an instance of the delegate oneArgeDelegate, and a string named weather, which is the argument for the callback.

// Schedule the update function in the UI thread.
tomorrowsWeather.Dispatcher.BeginInvoke(
    System.Windows.Threading.DispatcherPriority.Normal,
    new OneArgDelegate(UpdateUserInterface), 
    weather);

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 Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0
Show: