This documentation is archived and is not being maintained.

DispatcherOperation Class

Represents an object that is used to interact with an operation that has been posted to the Dispatcher queue.


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

Public NotInheritable Class DispatcherOperation

The DispatcherOperation type exposes the following members.

Public propertyDispatcherGets the Dispatcher that the operation was posted to.
Public propertyPriorityGets or sets the priority of the operation in the Dispatcher queue.
Public propertyResultGets the result of the operation after it has completed.
Public propertyStatusGets the current status of the operation..

Public methodAbortAborts the operation.
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodWaitWaits for the operation to complete
Public methodWait(TimeSpan)Waits for the operation to complete in the specified period of time.

Public eventAbortedOccurs when the operation is aborted.
Public eventCompletedOccurs when the operation has completed.

BeginInvoke returns a DispatcherOperation object when it is called.

The DispatcherOperation object can be used to interact with the delegate on the Dispatcher queue, such as changing the priority of the operation or aborting the operation.

To obtain the return value of the invoked delegate, use the Result property.

The DispatcherOperation is not an exception handling boundary. This means that exceptions are handled by the Dispatcher and are not preserved by the operation.

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

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