Dispatcher.Invoke Method (DispatcherPriority, Delegate, Object)

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

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

'Declaration
<BrowsableAttribute(False)> _
Public Function Invoke ( _
	priority As DispatcherPriority, _
	method As Delegate, _
	arg As Object _
) As Object

Parameters

priority
Type: System.Windows.Threading.DispatcherPriority

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

method
Type: System.Delegate

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

arg
Type: System.Object

An object to pass as an argument to the given method.

Return Value

Type: System.Object
The return value from the delegate being invoked or Nothing if the delegate has no return value.

ExceptionCondition
ArgumentException

priority is equal to Inactive.

InvalidEnumArgumentException

priority is not a valid priority.

ArgumentNullException

method is Nothing.

Arg can be Nothing if an argument is not needed

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.

Invoke is a synchronous operation; therefore, control will not return to the calling object until after the callback returns.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft