IAsyncRelayCommandExtensions.CreateCancelCommand(IAsyncRelayCommand) Method

Definition

Namespace:: CommunityToolkit.Mvvm.Input

Assembly:: CommunityToolkit.Mvvm.dll

Package:: CommunityToolkit.Mvvm v8.4.0

Source:: IAsyncRelayCommandExtensions.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.

Creates an ICommand instance that can be used to cancel execution on the input command. The returned command will also notify when it can be executed based on the state of the wrapped command.

public static System.Windows.Input.ICommand CreateCancelCommand(this CommunityToolkit.Mvvm.Input.IAsyncRelayCommand command);

static member CreateCancelCommand : CommunityToolkit.Mvvm.Input.IAsyncRelayCommand -> System.Windows.Input.ICommand

<Extension()>
Public Function CreateCancelCommand (command As IAsyncRelayCommand) As ICommand

Parameters

command: IAsyncRelayCommand

The input IAsyncRelayCommand instance to create a cancellation command for.

Returns

ICommand

An ICommand instance that can be used to monitor and signal cancellation for command.

Exceptions

ArgumentNullException

Thrown if command is null.

Remarks

The returned instance is not guaranteed to be unique across multiple invocations with the same arguments.

Applies to

Share via