Class RelayCommand

Namespace

CommunityToolkit.Mvvm.Input

Assembly

CommunityToolkit.Mvvm.dll

A command whose sole purpose is to relay its functionality to other objects by invoking delegates. The default return value for the CanExecute(object?) method is true. This type does not allow you to accept command parameters in the Execute(object?) and CanExecute(object?) callback methods.

public sealed class RelayCommand : IRelayCommand, ICommand

Inheritance

object

RelayCommand

Implements

IRelayCommand

ICommand

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

RelayCommand(Action)

Initializes a new instance of the RelayCommand class that can always execute.

public RelayCommand(Action execute)

Parameters

execute Action

The execution logic.

Exceptions

ArgumentNullException

Thrown if execute is null.

RelayCommand(Action, Func<bool>)

Initializes a new instance of the RelayCommand class.

public RelayCommand(Action execute, Func<bool> canExecute)

Parameters

execute Action

The execution logic.

canExecute Func<bool>

The execution status logic.

Exceptions

ArgumentNullException

Thrown if execute or canExecute are null.

Methods

CanExecute(object?)

public bool CanExecute(object? parameter)

Parameters

parameter object

Returns

bool

Execute(object?)

public void Execute(object? parameter)

Parameters

parameter object

NotifyCanExecuteChanged()

public void NotifyCanExecuteChanged()

Events

CanExecuteChanged

public event EventHandler? CanExecuteChanged

Event Type

EventHandler