Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

Dispatcher.BeginInvoke Method (Delegate, Object[])

Executes the specified delegate asynchronously with the specified arguments on the thread that the Dispatcher was created on.

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

public DispatcherOperation BeginInvoke(
	Delegate method,
	params Object[] args
)

Parameters

method
Type: System.Delegate
The delegate to a method that takes parameters specified in args, which is pushed onto the Dispatcher event queue.
args
Type: System.Object[]
An array of objects to pass as arguments to the given method. Can be null.

Return Value

Type: System.Windows.Threading.DispatcherOperation
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.

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 that created a DispatcherObject may access that object. For example, a background thread that is spun off from the main UI thread cannot update the contents of a Button that 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 that has shut down, the status property of the returned DispatcherOperation is set to Aborted.

.NET Framework

Supported in: 4, 3.5 SP1, 3.0 SP2

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Community Additions

Show:
© 2014 Microsoft