This topic has not yet been rated - Rate this topic

DispatcherOperation Class

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

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

System.Object
  System.Windows.Threading.DispatcherOperation
    System.Windows.Threading.DispatcherOperation<TResult>

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

public class DispatcherOperation

The DispatcherOperation type exposes the following members.

  Name Description
Public property Dispatcher Gets the Dispatcher that the operation was posted to.
Public property Priority Gets or sets the priority of the operation in the Dispatcher queue.
Public property Result Gets the result of the operation after it has completed.
Public property Status Gets the current status of the operation..
Public property Task Gets a System.Threading.Task that represents the current operation.
Top
  Name Description
Public method Abort Aborts the operation.
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetAwaiter Infrastructure. Returns an object that is notified when the asynchronous operation is finished.
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method InvokeDelegateCore Begins the operation that is associated with this DispatcherOperation.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method Wait() Waits for the operation to complete
Public method Wait(TimeSpan) Waits for the operation to complete in the specified period of time.
Top
  Name Description
Public event Aborted Occurs when the operation is aborted.
Public event Completed Occurs when the operation has completed.
Top

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.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8 Release Preview, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 SP2, 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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)