DispatcherOperation Class

Reference

Definition

Namespace:: System.Windows.Threading

Assembly:: WindowsBase.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public ref class DispatcherOperation sealed

public ref class DispatcherOperation

public sealed class DispatcherOperation

public class DispatcherOperation

type DispatcherOperation = class

Public NotInheritable Class DispatcherOperation

Public Class DispatcherOperation

Inheritance: Object
DispatcherOperation

Derived: System.Windows.Threading.DispatcherOperation<TResult>

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.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetAwaiter()	Returns an object that is notified when the asynchronous operation is finished.
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
InvokeDelegateCore()	Begins the operation that is associated with this DispatcherOperation.
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)
Wait()	Waits for the operation to complete.
Wait(TimeSpan)	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.

Applies to

Del via