Windows apps
Collapse the table of content
Expand the table of content
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.Invoke Method (Delegate, TimeSpan, DispatcherPriority, Object[])

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Executes the specified delegate within the designated time span at the specified priority with the specified arguments synchronously on the thread the Dispatcher is associated with.

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

public object Invoke(
	Delegate method,
	TimeSpan timeout,
	DispatcherPriority priority,
	params object[] args
)

Parameters

method
Type: System.Delegate

A delegate to a method that takes parameters specified in args, which is pushed onto the Dispatcher event queue.

timeout
Type: System.TimeSpan

The maximum amount of time to wait for the operation to complete.

priority
Type: System.Windows.Threading.DispatcherPriority

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

args
Type: System.Object[]

An array of objects to pass as arguments to the given method. Can be null.

Return Value

Type: System.Object

The return value from the delegate being invoked or null 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.

.NET Framework
Available since 3.0
Return to top
Show:
© 2017 Microsoft