Dispatcher Class

 

Provides services for managing the queue of work items for a thread.

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

System.Object
  System.Windows.Threading.Dispatcher

Public NotInheritable Class Dispatcher

NameDescription
System_CAPS_pubpropertySystem_CAPS_staticCurrentDispatcher

Gets the Dispatcher for the thread currently executing and creates a new Dispatcher if one is not already associated with the thread.

System_CAPS_pubpropertyHasShutdownFinished

Determines whether the Dispatcher has finished shutting down.

System_CAPS_pubpropertyHasShutdownStarted

Determines whether the Dispatcher is shutting down.

System_CAPS_pubpropertyHooks

Gets the collection of hooks that provide additional event information about the Dispatcher.

System_CAPS_pubpropertyThread

Gets the thread this Dispatcher is associated with.

NameDescription
System_CAPS_pubmethodBeginInvoke(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.

System_CAPS_pubmethodBeginInvoke(Delegate, Object())

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

System_CAPS_pubmethodBeginInvoke(DispatcherPriority, Delegate)

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

System_CAPS_pubmethodBeginInvoke(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.

System_CAPS_pubmethodBeginInvoke(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.

System_CAPS_pubmethodBeginInvokeShutdown(DispatcherPriority)

Initiates shutdown of the Dispatcher asynchronously.

System_CAPS_pubmethodCheckAccess()

Determines whether the calling thread is the thread associated with this Dispatcher.

System_CAPS_pubmethodDisableProcessing()

Disables processing of the Dispatcher queue.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodSystem_CAPS_staticExitAllFrames()

Requests that all frames exit, including nested frames.

System_CAPS_pubmethodSystem_CAPS_staticFromThread(Thread)

Gets the Dispatcher for the specified thread.

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodInvoke(Action)

Executes the specified Action synchronously on the thread the Dispatcher is associated with.

System_CAPS_pubmethodInvoke(Action, DispatcherPriority)

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

System_CAPS_pubmethodInvoke(Action, DispatcherPriority, CancellationToken)

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

System_CAPS_pubmethodInvoke(Action, DispatcherPriority, CancellationToken, TimeSpan)

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

System_CAPS_pubmethodInvoke(Delegate, DispatcherPriority, Object())

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

System_CAPS_pubmethodInvoke(Delegate, Object())

Executes the specified delegate with the specified arguments synchronously on the thread the Dispatcher is associated with.

System_CAPS_pubmethodInvoke(Delegate, TimeSpan, DispatcherPriority, Object())

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.

System_CAPS_pubmethodInvoke(Delegate, TimeSpan, Object())

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.

System_CAPS_pubmethodInvoke(DispatcherPriority, Delegate)

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

System_CAPS_pubmethodInvoke(DispatcherPriority, Delegate, Object)

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

System_CAPS_pubmethodInvoke(DispatcherPriority, Delegate, Object, Object())

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

System_CAPS_pubmethodInvoke(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.

System_CAPS_pubmethodInvoke(DispatcherPriority, TimeSpan, Delegate, Object)

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

System_CAPS_pubmethodInvoke(DispatcherPriority, TimeSpan, Delegate, Object, Object())

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

System_CAPS_pubmethodInvoke(Of TResult)(Func(Of TResult))

Executes the specified Func(Of TResult) synchronously on the thread the Dispatcher is associated with.

System_CAPS_pubmethodInvoke(Of TResult)(Func(Of TResult), DispatcherPriority)

Executes the specified Func(Of TResult) synchronously at the specified priority on the thread the Dispatcher is associated with.

System_CAPS_pubmethodInvoke(Of TResult)(Func(Of TResult), DispatcherPriority, CancellationToken)

Executes the specified Func(Of TResult) synchronously at the specified priority on the thread the Dispatcher is associated with.

System_CAPS_pubmethodInvoke(Of TResult)(Func(Of TResult), DispatcherPriority, CancellationToken, TimeSpan)

Executes the specified Func(Of TResult) synchronously at the specified priority on the thread the Dispatcher is associated with.

System_CAPS_pubmethodInvokeAsync(Action)

Executes the specified Action asynchronously on the thread the Dispatcher is associated with.

System_CAPS_pubmethodInvokeAsync(Action, DispatcherPriority)

Executes the specified Action asynchronously at the specified priority on the thread the Dispatcher is associated with.

System_CAPS_pubmethodInvokeAsync(Action, DispatcherPriority, CancellationToken)

Executes the specified Action asynchronously at the specified priority on the thread the Dispatcher is associated with.

System_CAPS_pubmethodInvokeAsync(Of TResult)(Func(Of TResult))

Executes the specified Func(Of TResult) asynchronously on the thread the Dispatcher is associated with.

System_CAPS_pubmethodInvokeAsync(Of TResult)(Func(Of TResult), DispatcherPriority)

Executes the specified Func(Of TResult) asynchronously at the specified priority on the thread the Dispatcher is associated with.

System_CAPS_pubmethodInvokeAsync(Of TResult)(Func(Of TResult), DispatcherPriority, CancellationToken)

Executes the specified Func(Of TResult) synchronously at the specified priority on the thread the Dispatcher is associated with.

System_CAPS_pubmethodInvokeShutdown()

Initiates the shutdown process of the Dispatcher synchronously.

System_CAPS_pubmethodSystem_CAPS_staticPushFrame(DispatcherFrame)

Enters an execute loop.

System_CAPS_pubmethodSystem_CAPS_staticRun()

Pushes the main execution frame on the event queue of the Dispatcher.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethodSystem_CAPS_staticValidatePriority(DispatcherPriority, String)

Determines whether the specified DispatcherPriority is a valid priority.

System_CAPS_pubmethodVerifyAccess()

Determines whether the calling thread has access to this Dispatcher.

System_CAPS_pubmethodSystem_CAPS_staticYield()

Creates an awaitable object that asynchronously yields control back to the current dispatcher and provides an opportunity for the dispatcher to process other events.

System_CAPS_pubmethodSystem_CAPS_staticYield(DispatcherPriority)

Creates an awaitable object that asynchronously yields control back to the current dispatcher and provides an opportunity for the dispatcher to process other events. The work that occurs when control returns to the code awaiting the result of this method is scheduled with the specified priority.

NameDescription
System_CAPS_pubeventShutdownFinished

Occurs when the Dispatcher finishes shutting down.

System_CAPS_pubeventShutdownStarted

Occurs when the Dispatcher begins to shut down.

System_CAPS_pubeventUnhandledException

Occurs when a thread exception is thrown and uncaught during execution of a delegate by way of Invoke or BeginInvoke.

System_CAPS_pubeventUnhandledExceptionFilter

Occurs when a thread exception is thrown and uncaught during execution of a delegate by way of Invoke or BeginInvoke when in the filter stage.

NameDescription
System_CAPS_pubmethodBeginInvoke(Action)

Overloaded. Executes the specified delegate asynchronously with normal priority on the thread that the specified Dispatcher was created on.(Defined by DispatcherExtensions.)

System_CAPS_pubmethodBeginInvoke(Action, DispatcherPriority)

Overloaded. Executes the specified delegate asynchronously with the specified priority on the thread that the specified Dispatcher was created on.(Defined by DispatcherExtensions.)

System_CAPS_pubmethodInvoke(Action, TimeSpan)

Overloaded. Executes the specified delegate synchronously on the thread that the specified Dispatcher was created on, and stops execution after the specified time-out period. (Defined by DispatcherExtensions.)

System_CAPS_pubmethodInvoke(Action, TimeSpan, DispatcherPriority)

Overloaded. Executes the specified delegate synchronously with the specified priority on the thread that the specified Dispatcher was created on, and stops execution after the specified time-out period.(Defined by DispatcherExtensions.)

The Dispatcher maintains a prioritized queue of work items for a specific thread.

When a Dispatcher is created on a thread, it becomes the only Dispatcher that can be associated with the thread, even if the Dispatcher is shut down.

If you attempt to get the CurrentDispatcher for the current thread and a Dispatcher is not associated with the thread, a Dispatcher will be created. A Dispatcher is also created when you create a DispatcherObject. If you create a Dispatcher on a background thread, be sure to shut down the dispatcher before exiting the thread.

If a Dispatcher is shut down, it cannot be restarted.

In WPF, a DispatcherObject can only be accessed by the Dispatcher it is associated with.  For example, a background thread cannot update the contents of a Button that is associated with the Dispatcher 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 BeginInvokeInvoke is synchronous and BeginInvoke is asynchronous. The operation is added to the 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.

All of the methods on Dispatcher, with the exception of DisableProcessing, are free-threaded.

Objects that derive from DispatcherObject have thread affinity.

Objects that derive from Freezable are free-threaded when they are frozen. For more information, see Freezable Objects Overview.

The following example shows how to place an operation onto a Dispatcher. For the full source code of this example, see Single-Threaded Application with Long-Running Calculation Sample.

First, a delegate is created that accepts no arguments.

Public Delegate Sub NextPrimeDelegate()

Next, BeginInvoke(DispatcherPriority, Delegate) is called. This call to BeginInvoke(DispatcherPriority, Delegate) takes two parameters: the priority, which is set to DispatcherPriority.Normal, and the callback, which is passed in through an instance of the delegate NextPrimeDelegate.

startStopButton.Dispatcher.BeginInvoke(DispatcherPriority.Normal, New NextPrimeDelegate(AddressOf CheckNextNumber))

.NET Framework
Available since 3.0
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: