DispatcherOperation Class

DispatcherOperation Class

 

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

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

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

type DispatcherOperation = class end

NameDescription
System_CAPS_pubpropertyDispatcher

Gets the Dispatcher that the operation was posted to.

System_CAPS_pubpropertyPriority

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

System_CAPS_pubpropertyResult

Gets the result of the operation after it has completed.

System_CAPS_pubpropertyStatus

Gets the current status of the operation..

System_CAPS_pubpropertyTask

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

NameDescription
System_CAPS_pubmethodAbort()

Aborts the operation.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetAwaiter()

This API supports the product infrastructure and is not intended to be used directly from your code. Returns an object that is notified when the asynchronous operation is finished.

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodInvokeDelegateCore()

Begins the operation that is associated with this DispatcherOperation.

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethodWait()

Waits for the operation to complete

System_CAPS_pubmethodWait(TimeSpan)

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

NameDescription
System_CAPS_pubeventAborted

Occurs when the operation is aborted.

System_CAPS_pubeventCompleted

Occurs when the operation has completed.

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
Available since 3.0
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft