C# Class Zetbox.Client.WPF.Commands.SmartRoutedUICommand

This abstract class is a RoutedCommand which allows its subclasses to provide default logic for determining if they can execute and how to execute. To enable the default logic to be used, set the IsCommandSink attached property to true on the root element of the element tree which uses one or more SmartRoutedCommand subclasses.

Inheritance: System.Windows.Input.RoutedUICommand

Show file Open project: daszat/zetbox Class Usage Examples

Public Properties

Property	Type	Description
IsCommandSinkProperty	System.Windows.DependencyProperty

Public Methods

Method	Description
GetIsCommandSink ( DependencyObject obj ) : bool	Returns a value indicating whether or not the specified DependencyObject is a command sink or not.
SetIsCommandSink ( DependencyObject obj, bool value ) : void	Sets the value indicating whether or not the specified DependencyObject is a command sink or not.
SmartRoutedUICommand ( string text, Type ownerType ) : System	Initializes a new instance of the SmartRoutedUICommand class, specifying a label and an owner class.

Protected Methods

Method	Description
CanExecuteCore ( object parameter ) : bool	Child classes override this method to provide logic which determines if the command can execute. This method will only be invoked if no element in the tree indicated that it can execute the command.
ExecuteCore ( object parameter ) : void	Child classes override this method to provide default execution logic. This method will only be invoked if CanExecuteCore returns true.

Private Methods

Method	Description
OnCanExecute ( object sender, System.Windows.Input.CanExecuteRoutedEventArgs e ) : void	Event handler, called when CanExecute changes.
OnExecuted ( object sender, System.Windows.Input.ExecutedRoutedEventArgs e ) : void	Event handler, called when Executed changes.
OnIsCommandSinkChanged ( DependencyObject depObj, System.Windows.DependencyPropertyChangedEventArgs e ) : void	Invoked when the IsCommandSink attached property is set on an element.

Method Details

CanExecuteCore() protected abstract method

Child classes override this method to provide logic which determines if the command can execute. This method will only be invoked if no element in the tree indicated that it can execute the command.

protected abstract CanExecuteCore ( object parameter ) : bool
parameter	object	The command parameter (optional).
return	bool

ExecuteCore() protected abstract method

Child classes override this method to provide default execution logic. This method will only be invoked if CanExecuteCore returns true.

protected abstract ExecuteCore ( object parameter ) : void
parameter	object	The command parameter (optional).
return	void

GetIsCommandSink() public static method

Returns a value indicating whether or not the specified DependencyObject is a command sink or not.

public static GetIsCommandSink ( DependencyObject obj ) : bool
obj	System.Windows.DependencyObject	the object to check
return	bool

SetIsCommandSink() public static method

Sets the value indicating whether or not the specified DependencyObject is a command sink or not.

if is null

public static SetIsCommandSink ( DependencyObject obj, bool value ) : void
obj	System.Windows.DependencyObject	the object to modify
value	bool	true if the passed object is a command sink, false otherwise
return	void

SmartRoutedUICommand() public method

Initializes a new instance of the SmartRoutedUICommand class, specifying a label and an owner class.

public SmartRoutedUICommand ( string text, Type ownerType ) : System
text	string	the label to use
ownerType	System.Type	the owner class to use
return	System

Property Details

IsCommandSinkProperty public static property

Represents the IsCommandSink attached property. This is readonly.

public static DependencyProperty,System.Windows IsCommandSinkProperty
return	System.Windows.DependencyProperty