Dispatcher.BeginInvoke Method

Executes a delegate asynchronously on the thread the Dispatcher is associated with.

This member is overloaded. For complete information about this member, including syntax, usage, and examples, click a name in the overload list.

  NameDescription
Public method BeginInvoke(Delegate, Object[]) Executes the specified delegate asynchronously with the specified arguments on the thread that the Dispatcher was created on.
Public method BeginInvoke(DispatcherPriority, Delegate) Executes the specified delegate asynchronously at the specified priority on the thread the Dispatcher is associated with.
Public method BeginInvoke(Delegate, DispatcherPriority, Object[]) Executes the specified delegate asynchronously with the specified arguments, at the specified priority, on the thread that the Dispatcher was created on.
Public method BeginInvoke(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.
Public method BeginInvoke(DispatcherPriority, Delegate, Object, Object[]) Executes the specified delegate asynchronously at the specified priority and with the specified array of arguments on the thread the Dispatcher is associated with.
Top

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.

BeginInvoke is asynchronous; therefore, control returns immediately to the calling object after it is called.

BeginInvoke returns a DispatcherOperation object that 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.

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 that has shut down, the status property of the returned DispatcherOperation is set to Aborted.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft