Dispatcher​Operation Class

Definition

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

public class DispatcherOperation
Inheritance
DispatcherOperation
Derived

Inherited Members

System.Object

Remarks

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.

Properties

Dispatcher

Gets the Dispatcher that the operation was posted to.

Priority

Gets or sets the priority of the operation in the Dispatcher queue.

Result

Gets the result of the operation after it has completed.

Status

Gets the current status of the operation..

Task

Gets a Task<TResult> that represents the current operation.

Methods

Abort()

Aborts the operation.

Get​Awaiter()

Returns an object that is notified when the asynchronous operation is finished.

Invoke​Delegate​Core()

Begins the operation that is associated with this DispatcherOperation.

Wait()

Waits for the operation to complete

Wait(​Time​Span)

Waits for the operation to complete in the specified period of time.

Events

Aborted

Occurs when the operation is aborted.

Completed

Occurs when the operation has completed.