Dispatcher.Invoke Method (DispatcherPriority, TimeSpan, Delegate)

Executes the specified delegate synchronously at the specified priority and with the specified time-out value on the thread the Dispatcher was created.

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

public function Invoke(
	priority : DispatcherPriority, 
	timeout : TimeSpan, 
	method : Delegate
) : Object
You cannot use methods in XAML.

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.

timeout
Type: System.TimeSpan

The maximum time to wait for the operation to finish.

method
Type: System.Delegate

The delegate to a method that takes no arguments, which is pushed onto the Dispatcher event queue.

Return Value

Type: System.Object
The return value from the delegate being invoked or a null reference (Nothing in Visual Basic) if the delegate has no return value.

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.

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

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

.NET Framework

Supported in: 3.5, 3.0
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft