Meziantou.Framework

DispatcherExtensions.SwitchToUiAwaitable Struct

Namespace
Meziantou.Framework.WPF
Assembly
Meziantou.Framework.WPF.dll
Package
Meziantou.Framework.WPF 4.0.2
Source
DispatcherExtensions.cs
Available in package assets
net10.0-windows7.0net11.0-windows7.0
Declared in
DispatcherExtensions

An awaitable that switches execution to the UI thread.

public readonly struct SwitchToUiAwaitable : INotifyCompletion

Remarks

Instances must be obtained from DispatcherExtensions.SwitchToDispatcherThread. A default-initialized value has no dispatcher to switch to and throws InvalidOperationException when awaited.

Implements

Properties

NameDescription
IsCompletedGets a value indicating whether the awaiter has completed.

IsCompleted

DispatcherExtensions.cs

Gets a value indicating whether the awaiter has completed.

public bool IsCompleted { get; }

Property value

bool

Exceptions

InvalidOperationException
The instance was default-initialized instead of being obtained from DispatcherExtensions.SwitchToDispatcherThread.

Methods

NameDescription
GetAwaiter()Gets the awaiter for this awaitable.
GetResult()Ends the await operation.
OnCompleted(Action)Schedules the continuation action to run on the dispatcher thread.

GetAwaiter()

DispatcherExtensions.cs

Gets the awaiter for this awaitable.

public DispatcherExtensions.SwitchToUiAwaitable GetAwaiter()

Returns

DispatcherExtensions.SwitchToUiAwaitable This instance.

GetResult()

DispatcherExtensions.cs

Ends the await operation.

public void GetResult()

OnCompleted(Action)

DispatcherExtensions.cs

Schedules the continuation action to run on the dispatcher thread.

public void OnCompleted(Action continuation)

Parameters

continuation Action
The continuation action.

Exceptions

InvalidOperationException
The instance was default-initialized instead of being obtained from DispatcherExtensions.SwitchToDispatcherThread, or the dispatcher has already shut down.