Paradox Game Engine  v1.0.0 beta06
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros Pages
SiliconStudio.Presentation.Commands.CommandBase Class Referenceabstract

An abstract class that is the base implementation of the ICommandBase interface. More...

Inheritance diagram for SiliconStudio.Presentation.Commands.CommandBase:
SiliconStudio.Presentation.ViewModel.DispatcherViewModel SiliconStudio.Presentation.Commands.ICommandBase SiliconStudio.Presentation.ViewModel.ViewModelBase INotifyPropertyChanging INotifyPropertyChanged SiliconStudio.Presentation.Commands.AnonymousCommand SiliconStudio.Presentation.Commands.AnonymousCommand< T > SiliconStudio.Presentation.Commands.AsyncCommand SiliconStudio.Presentation.Commands.CancellableCommand SiliconStudio.Presentation.Quantum.NodeCommandWrapperBase SiliconStudio.Presentation.Quantum.AnonymousCommandWrapper SiliconStudio.Presentation.Quantum.CombinedNodeCommandWrapper SiliconStudio.Presentation.Quantum.ModelNodeCommandWrapper

Public Member Functions

virtual bool CanExecute (object parameter)
 
abstract void Execute (object parameter)
 
bool CanExecute ()
 Invokes CanExecute(object) with a null argument. More...
 
void Execute ()
 Invokes the Execute(object) command with a null argument. More...
 

Protected Member Functions

 CommandBase (IViewModelServiceProvider serviceProvider)
 Initializes a new instance of the CommandBase class. More...
 
- Protected Member Functions inherited from SiliconStudio.Presentation.ViewModel.DispatcherViewModel
 DispatcherViewModel (IViewModelServiceProvider serviceProvider)
 Initializes a new instance of the DispatcherViewModel class. More...
 
override void OnPropertyChanging (params string[] propertyNames)
 This method will raise the PropertyChanging for each of the property name passed as argument.
Parameters
propertyNamesThe names of the properties that is changing.
More...
 
override void OnPropertyChanged (params string[] propertyNames)
 This method will raise the PropertyChanged for each of the property name passed as argument.
Parameters
propertyNamesThe names of the properties that has changed.
More...
 
- Protected Member Functions inherited from SiliconStudio.Presentation.ViewModel.ViewModelBase
 ViewModelBase ()
 
 ViewModelBase (IViewModelServiceProvider serviceProvider)
 
bool SetValue< T > (ref T field, T value, [CallerMemberName]string propertyName=null)
 Sets the value of a field to the given value. Both values are compared with the default EqualityComparer{T}, and if they are equals, this method does nothing. If they are different, the PropertyChanging event will be raised first, then the field value will be modified, and finally the PropertyChanged event will be raised. More...
 
bool SetValue< T > (ref T field, T value, params string[] propertyNames)
 Sets the value of a field to the given value. Both values are compared with the default EqualityComparer{T}, and if they are equals, this method does nothing. If they are different, the PropertyChanging will be raised first, then the field value will be modified, and finally the PropertyChanged event will be raised. More...
 
bool SetValue< T > (ref T field, T value, Action updateAction, [CallerMemberName]string propertyName=null)
 Sets the value of a field to the given value. Both values are compared with the default EqualityComparer{T}, and if they are equals, this method does nothing. If they are different, the PropertyChanging event will be raised first, then the field value will be modified. The given update action will be executed and finally the PropertyChanged event will be raised. More...
 
virtual bool SetValue< T > (ref T field, T value, Action updateAction, params string[] propertyNames)
 Sets the value of a field to the given value. Both values are compared with the default EqualityComparer{T}, and if they are equals, this method does nothing. If they are different, the PropertyChanging event will be raised first, then the field value will be modified. The given update action will be executed and finally the PropertyChanged event will be raised. More...
 
bool SetValue (Action updateAction, [CallerMemberName]string propertyName=null)
 Manages a property modification and its notifications. This method will invoke the provided update action. The PropertyChanging event will be raised prior to the update action, and the PropertyChanged event will be raised after. More...
 
bool SetValue (Action updateAction, params string[] propertyNames)
 Manages a property modification and its notifications. This method will invoke the provided update action. The PropertyChanging event will be raised prior to the update action, and the PropertyChanged event will be raised after. More...
 
bool SetValue (Func< bool > hasChangedFunction, Action updateAction, [CallerMemberName]string propertyName=null)
 Manages a property modification and its notifications. A function is provided to check whether the new value is different from the current one. This function will be invoked by this method, and if it returns True, it will invoke the provided update action. The PropertyChanging event will be raised prior to the update action, and the PropertyChanged event will be raised after. More...
 
bool SetValue (bool hasChanged, Action updateAction, [CallerMemberName]string propertyName=null)
 Manages a property modification and its notifications. The first parameter hasChanged should indicate whether the property should actuallybe updated. If this parameter is True, it will invoke the provided update action. The PropertyChanging event will be raised prior to the update action, and the PropertyChanged event will be raised after. More...
 
bool SetValue (bool hasChanged, Action updateAction, params string[] propertyNames)
 Manages a property modification and its notifications. The first parameter hasChanged should indicate whether the property should actuallybe updated. If this parameter is True, it will invoke the provided update action. The PropertyChanging event will be raised prior to the update action, and the PropertyChanged event will be raised after. More...
 
virtual bool SetValue (Func< bool > hasChangedFunction, Action updateAction, params string[] propertyNames)
 Manages a property modification and its notifications. A function is provided to check whether the new value is different from the current one. This function will be invoked by this method, and if it returns True, it will invoke the provided update action. The PropertyChanging event will be raised prior to the update action, and the PropertyChanged event will be raised after. More...
 

Properties

bool IsEnabled [get, set]
 
- Properties inherited from SiliconStudio.Presentation.ViewModel.DispatcherViewModel
IDispatcherService Dispatcher [get, set]
 Gets a dispatcher that is capable of executing code in the UI thread. More...
 
- Properties inherited from SiliconStudio.Presentation.Commands.ICommandBase
bool IsEnabled [get, set]
 Indicates whether the command can be executed or not. More...
 

Events

EventHandler CanExecuteChanged
 
- Events inherited from SiliconStudio.Presentation.ViewModel.ViewModelBase
PropertyChangingEventHandler PropertyChanging
 
PropertyChangedEventHandler PropertyChanged
 

Additional Inherited Members

- Public Attributes inherited from SiliconStudio.Presentation.ViewModel.ViewModelBase
IViewModelServiceProvider ServiceProvider = ViewModelServiceProvider.NullServiceProvider
 An IViewModelServiceProvider that allows to retrieve various service objects. More...
 
- Protected Attributes inherited from SiliconStudio.Presentation.ViewModel.ViewModelBase
List< Tuple< string, string > > DependentProperties = new List<Tuple<string, string>>()
 A list of couple of property names that are dependent. For each couple of this list, if the first property name is notified as being changed, then the second property name will also be notified has being changed. More...
 

Detailed Description

An abstract class that is the base implementation of the ICommandBase interface.

Definition at line 13 of file CommandBase.cs.

Constructor & Destructor Documentation

SiliconStudio.Presentation.Commands.CommandBase.CommandBase ( IViewModelServiceProvider  serviceProvider)
protected

Initializes a new instance of the CommandBase class.

Parameters
serviceProviderA service provider that can provide a IDispatcherService to use for this view model.

Definition at line 24 of file CommandBase.cs.

Member Function Documentation

virtual bool SiliconStudio.Presentation.Commands.CommandBase.CanExecute ( object  parameter)
virtual
bool SiliconStudio.Presentation.Commands.CommandBase.CanExecute ( )

Invokes CanExecute(object) with a null argument.

Returns
true if CanExecute(object) returned true, false otherwise.

Definition at line 48 of file CommandBase.cs.

void SiliconStudio.Presentation.Commands.CommandBase.Execute ( )

Invokes the Execute(object) command with a null argument.

Implements SiliconStudio.Presentation.Commands.ICommandBase.

Definition at line 56 of file CommandBase.cs.

Property Documentation

bool SiliconStudio.Presentation.Commands.CommandBase.IsEnabled
getset

Definition at line 30 of file CommandBase.cs.

Event Documentation

EventHandler SiliconStudio.Presentation.Commands.CommandBase.CanExecuteChanged

Definition at line 33 of file CommandBase.cs.


The documentation for this class was generated from the following file: