IAsyncRelayCommand.CanBeCanceled Property

Definition

Namespace:: CommunityToolkit.Mvvm.Input

Assembly:: CommunityToolkit.Mvvm.dll

Package:: CommunityToolkit.Mvvm v8.4.0

Package:: CommunityToolkit.Mvvm v7.0.3

Source:: IAsyncRelayCommand.cs

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.

Gets a value indicating whether a running operation for this command can currently be canceled.

public bool CanBeCanceled { get; }

member this.CanBeCanceled : bool

Public ReadOnly Property CanBeCanceled As Boolean

Property Value

Boolean

Remarks

The exact sequence of events that types implementing this interface should raise is as follows:

The command is initially not running: IsRunning, CanBeCanceled and IsCancellationRequested are false.
The command starts running: IsRunning and CanBeCanceled switch to true. IsCancellationRequested is set to false.
If the operation is canceled: CanBeCanceled switches to false and IsCancellationRequested switches to true.
The operation completes: IsRunning and CanBeCanceled switch to false. The state of IsCancellationRequested is undefined.

This only applies if the underlying logic for the command actually supports cancelation. If that is not the case, then CanBeCanceled and IsCancellationRequested will always remain false regardless of the current state of the command.

Applies to