Common Application Framework

Command Members

Command overview

Public Instance Constructors

Command Constructor Command constructor

Public Instance Properties

Checked Gets or sets if the command is in a checked state. Setting this value will set the CommandExecutor.Checked property on all attached CommandExecutors.
Description Description for the command
Enabled Gets or sets if the command is enabled. Setting this value will set the CommandExecutor.Enabled property on all attached CommandExecutors.
ExecuteOnCheckedChange
Internal Flag to control the visibility of the command in Customization dialog
IsValid Gets the IsValid status of the command. A Command may become invalid in some application context. Method can be overriden in a derived class.
Key The commands key in the CommandCollection
List ArrayList which can contain data to be presented in the GUI
SelectedIndex Used to comunicate to the command which item in the list was selected
Value Setting this value will set the CommandExecutor.Value property on all attached CommandExecutors.
ValueChanged True if the value of the command has been changed
Visible Gets or sets if the command is visible. Setting this value will set the CommandExecutor.Visible property on all attached CommandExecutors.

Public Instance Methods

AttachExecutor Attaches a CommandExecutor derived class to the command
CancelableExecute Version of Execute which can be cancelled by an BeforeCommandExecute event handler
DetachAllExecutors Detach all CommandExecutor derived classes from the command
DetachExecutor Detach a CommandExecutor derived class from the command
Equals (inherited from Object) Determines whether the specified Object is equal to the current Object.
Execute The command Execute method is normally overridden by a derived class
GetHashCode (inherited from Object) Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetState Gets the current state of the command
GetType (inherited from Object) Gets the Type of the current instance.
RefreshOverloaded. Call to allow the command to update its visilility or enabled state following a change to the application context.
SetProperty
ToString (inherited from Object) Returns a String that represents the current Object.

Public Instance Events

BeforeCommandExecute Occurs before the command is executed
CommandExecuted Occurs when the command is executed

See Also

Command Class | Aveva.ApplicationFramework.Presentation Namespace