DispatcherOperation Class
Definition
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 DispatcherOperationpublic class DispatcherOperationtype DispatcherOperation = classPublic Class DispatcherOperation- Inheritance
-
DispatcherOperation
- 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
| Name | Description |
|---|---|
| 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
| Name | Description |
|---|---|
| Abort() |
Aborts the operation. |
| GetAwaiter() |
Returns an object that is notified when the asynchronous operation is finished. |
| InvokeDelegateCore() |
Begins the operation that is associated with this DispatcherOperation. |
| Wait() |
Waits for the operation to complete. |
| Wait(TimeSpan) |
Waits for the operation to complete in the specified period of time. |
Events
| Name | Description |
|---|---|
| Aborted |
Occurs when the operation is aborted. |
| Completed |
Occurs when the operation has completed. |
