AsyncRelayCommand Class |
A reusable command that encapsulates the implementation of ICommand with support for async/await. Enables instant creation of an ICommand without implementing the ICommand interface for each command.
The AsyncRelayCommand accepts asynchronous command handlers.
Inheritance HierarchySystemObject
BionicCode.Utilities.Net.Framework.Wpf.GenericAsyncRelayCommandObject
BionicCode.Utilities.Net.Framework.WpfAsyncRelayCommand
BionicCode.Utilities.Net.Framework.Wpf.GenericAsyncRelayCommandObject
BionicCode.Utilities.Net.Framework.WpfAsyncRelayCommand
Namespace: BionicCode.Utilities.Net.Framework.Wpf
Assembly: BionicCode.Utilities.Net.Framework.Wpf (in BionicCode.Utilities.Net.Framework.Wpf.dll) Version: 1.0.3.0 (1.0.0.0)
SyntaxThe AsyncRelayCommand type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | AsyncRelayCommand(Action) |
Creates a new parameterless command that can always execute (CanExecute will always return true).
|
| AsyncRelayCommand(ActionObject) | Initializes a new instance of the AsyncRelayCommand class |
| AsyncRelayCommand(FuncTask) |
Creates a new parameterless asynchronous command that can always execute (CanExecute will always return true).
|
| AsyncRelayCommand(FuncObject, Task) | Initializes a new instance of the AsyncRelayCommand class |
| AsyncRelayCommand(Action, FuncBoolean) |
Creates a new parameterless command.
|
| AsyncRelayCommand(ActionObject, PredicateObject) | Initializes a new instance of the AsyncRelayCommand class |
| AsyncRelayCommand(FuncTask, FuncBoolean) |
Creates a parameterless new asynchronous command.
|
| AsyncRelayCommand(FuncObject, Task, PredicateObject) | Initializes a new instance of the AsyncRelayCommand class |
Properties| Name | Description | |
|---|---|---|
 | IsExecuting |
Extends ICommand to allow asynchronous command execution, where the accepted parameter of the ExecuteAsync(TParam) and CanExecute is strongly typed to eliminate type casting inside the registered callbacks.
(Inherited from AsyncRelayCommandTParam.) |
Methods| Name | Description | |
|---|---|---|
| CanExecute |
Determines whether this AsyncRelayCommand can execute.
(Inherited from AsyncRelayCommandTParam.) |
| CanExecute(TParam) |
Determines whether this AsyncRelayCommand can execute.
(Inherited from AsyncRelayCommandTParam.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| ExecuteAsync |
Executes the AsyncRelayCommand on the current command target asynchronously.
(Inherited from AsyncRelayCommandTParam.) |
| ExecuteAsync(CancellationToken) |
Executes the AsyncRelayCommand on the current command target asynchronously.
(Inherited from AsyncRelayCommandTParam.) |
| ExecuteAsync(TParam) |
Executes the AsyncRelayCommand on the current command target asynchronously.
(Inherited from AsyncRelayCommandTParam.) |
| ExecuteAsync(TParam, CancellationToken) |
Executes the AsyncRelayCommand on the current command target asynchronously.
(Inherited from AsyncRelayCommandTParam.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| InvalidateCommand |
Extends ICommand to allow asynchronous command execution, where the accepted parameter of the ExecuteAsync(TParam) and CanExecute is strongly typed to eliminate type casting inside the registered callbacks.
(Inherited from AsyncRelayCommandTParam.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnCanExecuteChanged |
Raises the CanExecuteChanged event.
(Inherited from AsyncRelayCommandTParam.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Events| Name | Description | |
|---|---|---|
 | CanExecuteChanged | Occurs when changes occur that affect whether or not the command should execute. (Inherited from AsyncRelayCommandTParam.) |
Fields| Name | Description | |
|---|---|---|
 | CanExecuteNoParam |
The registered parameterless CanExecute delegate.
(Inherited from AsyncRelayCommandTParam.) |
| ExecuteAsyncNoParam |
The registered parameterless async execute delegate.
(Inherited from AsyncRelayCommandTParam.) |
| ExecuteNoParam |
The registered parameterless synchronous execute delegate.
(Inherited from AsyncRelayCommandTParam.) |
Extension Methods| Name | Description | |
|---|---|---|
 | ToDictionary | Overloaded.
Coverts any type to a DictionaryTKey, TValue, where the TKey is the member name and TValue the member's value.
(Defined by HelperExtensions.) |
| ToDictionary | Overloaded.
Coverts any type to a DictionaryTKey, TValue, where the TKey is the member name and TValue the member's value.
(Defined by HelperExtensions.) |
Explicit Interface Implementations| Name | Description | |
|---|---|---|
  | ICommandCanExecute |
Explicit ICommand implementation. Determines whether this AsyncRelayCommand can execute.
(Inherited from AsyncRelayCommandTParam.) |
| ICommandExecute |
Explicit ICommand implementation. Executes the AsyncRelayCommand on the current command target.
(Inherited from AsyncRelayCommandTParam.) |
| IAsyncRelayCommandExecuteAsync(Object) |
Asynchronously executes the AsyncRelayCommand on the current command target.
(Inherited from AsyncRelayCommandTParam.) |
| IAsyncRelayCommandExecuteAsync(Object, CancellationToken) |
Asynchronously executes the AsyncRelayCommand on the current command target.
(Inherited from AsyncRelayCommandTParam.) |
RemarksAsyncRelayCommand implements ICommand. In case Execute(Object) is invoked with a registered asynchronous command handler (e.g., by an implementation of ICommandSource), the handler is executed asynchronously. In case the AsyncRelayCommand is executed explicitly, especially with an asynchronous command handler registered, it is highly recommended to invoke the awaitable ExecuteAsync(object) or one of its overloads instead!
See Also