Share via


RelayCommand Class

A command whose sole purpose is to relay its functionality to other objects by invoking delegates. The default return value for the CanExecute method is 'true'.

Inheritance Hierarchy

System.Object
  Microsoft.TeamFoundation.MVVM.NotifyPropertyChangedDispatcherObject
    Microsoft.TeamFoundation.MVVM.RelayCommand

Namespace:  Microsoft.TeamFoundation.MVVM
Assembly:  Microsoft.TeamFoundation.Controls (in Microsoft.TeamFoundation.Controls.dll)

Syntax

'Declaration
Public Class RelayCommand _
    Inherits NotifyPropertyChangedDispatcherObject _
    Implements IOwnedCommand, ICommand
public class RelayCommand : NotifyPropertyChangedDispatcherObject, 
    IOwnedCommand, ICommand
public ref class RelayCommand : public NotifyPropertyChangedDispatcherObject, 
    IOwnedCommand, ICommand
type RelayCommand =  
    class 
        inherit NotifyPropertyChangedDispatcherObject 
        interface IOwnedCommand 
        interface ICommand 
    end
public class RelayCommand extends NotifyPropertyChangedDispatcherObject implements IOwnedCommand, ICommand

The RelayCommand type exposes the following members.

Constructors

  Name Description
Public method RelayCommand(Action) Creates a new command that can always execute.
Public method RelayCommand(Action<Object>) Creates a new command that can always execute.
Public method RelayCommand(Action<Object>, Predicate<Object>) Creates a new command.

Top

Properties

  Name Description
Public property Dispatcher Dispatcher associated with this object. (Inherited from NotifyPropertyChangedDispatcherObject.)
Public property IsExecuting True if command is executing, false otherwise.

Top

Methods

  Name Description
Protected method AddDependencySource(String, INotifyCollectionChanged) (Inherited from NotifyPropertyChangedDispatcherObject.)
Protected method AddDependencySource(String, INotifyPropertyChanged) (Inherited from NotifyPropertyChangedDispatcherObject.)
Public method CanExecute
Public method CheckAccessBeginExecute Executes the specified action on a thread associated with object's dispatcher. This invokes a BeginInvoke on the Dispatcher, does not wait for the action to complete -- returns immediately. (Inherited from NotifyPropertyChangedDispatcherObject.)
Public method CheckAccessExecute(Action) Executes the specified action on a thread associated with object's dispatcher. (Inherited from NotifyPropertyChangedDispatcherObject.)
Public method CheckAccessExecute<TResult>(Func<TResult>) (Inherited from NotifyPropertyChangedDispatcherObject.)
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public method Execute
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Protected method GetDependencySourceName(INotifyCollectionChanged) (Inherited from NotifyPropertyChangedDispatcherObject.)
Protected method GetDependencySourceName(INotifyPropertyChanged) (Inherited from NotifyPropertyChangedDispatcherObject.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method RaiseCanExecuteChanged
Protected method RaisePropertyChanged Raises PropertyChanged event. This method can only be called on the thread associated with this object's dispatcher. (Inherited from NotifyPropertyChangedDispatcherObject.)
Protected method ReceiveWeakEvent (Inherited from NotifyPropertyChangedDispatcherObject.)
Protected method RemoveDependencySource(String, INotifyCollectionChanged) (Inherited from NotifyPropertyChangedDispatcherObject.)
Protected method RemoveDependencySource(String, INotifyPropertyChanged) (Inherited from NotifyPropertyChangedDispatcherObject.)
Protected method SetAndRaisePropertyChanged(Boolean%, Boolean, String) A helper method that sets property value and raises PropertyChanged event if the value has changed. Optimized implementation for System.Boolean type. (Inherited from NotifyPropertyChangedDispatcherObject.)
Protected method SetAndRaisePropertyChanged(Int32%, Int32, String) A helper method that sets property value and raises PropertyChanged event if the value has changed. Optimized implementation for System.Int32 type. (Inherited from NotifyPropertyChangedDispatcherObject.)
Protected method SetAndRaisePropertyChanged(String%, String, String) A helper method that sets property value and raises PropertyChanged event if the value has changed. Optimized implementation for string type. (Inherited from NotifyPropertyChangedDispatcherObject.)
Protected method SetAndRaisePropertyChanged<T>(T%, T, String) A helper method that sets property value and raises PropertyChanged event if the value has changed. (Inherited from NotifyPropertyChangedDispatcherObject.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Protected method VerifyAccess Enforces that the calling thread has access to this object. (Inherited from NotifyPropertyChangedDispatcherObject.)

Top

Events

  Name Description
Public event CanExecuteChanged Raised when CanExecute changes.
Public event PropertyChanged Occurs when a property value changes. (Inherited from NotifyPropertyChangedDispatcherObject.)

Top

Fields

  Name Description
Public fieldStatic member IsExecutingProperty

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IWeakEventListener.ReceiveWeakEvent (Inherited from NotifyPropertyChangedDispatcherObject.)

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.TeamFoundation.MVVM Namespace