DispatcherOperation DispatcherOperation DispatcherOperation Class

Definition

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

public ref class DispatcherOperation
public class DispatcherOperation
Public Class DispatcherOperation
Inheritance
DispatcherOperationDispatcherOperationDispatcherOperation
Derived

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 Dispatcher Dispatcher

Gets the Dispatcher that the operation was posted to.

Priority Priority Priority

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

Result Result Result

Gets the result of the operation after it has completed.

Status Status Status

Gets the current status of the operation..

Task Task Task

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

Methods

Abort() Abort() Abort()

Aborts the operation.

Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetAwaiter() GetAwaiter() GetAwaiter()

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

GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
InvokeDelegateCore() InvokeDelegateCore() InvokeDelegateCore()

Begins the operation that is associated with this DispatcherOperation.

MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString()

Returns a string that represents the current object.

(Inherited from Object)
Wait() Wait() Wait()

Waits for the operation to complete

Wait(TimeSpan) Wait(TimeSpan) Wait(TimeSpan)

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

Events

Aborted Aborted Aborted

Occurs when the operation is aborted.

Completed Completed Completed

Occurs when the operation has completed.

Applies to