AVEVA CAF API Documenation
Fields  Properties  Methods  Events


Command Class Members

The following tables list the members exposed by Command.

Public Fields
 NameDescription
Public Field true if message displayed.  
Top
Public Properties
 NameDescription
Public Property Get/Set AllowWaitCusor value.  
Public Property Application context for which this command is valid.  
Public Property Get the number of CommandExecutors attached to the command  
Public Property Gets or sets if the command is in a checked state. Setting this value will set the CommandExecutor.Checked property on all attached CommandExecutors.  
Public Property Key to Context object.  
Public Property Description for the command.  
Public Property Gets or sets if the command is enabled. Setting this value will set the CommandExecutor.Enabled property on all attached CommandExecutors.  
Public Property Gets or sets a value indicating whether the execute on checked change.  
Public Property Get all command Execute overloads.  
Public Property Gets a value indicating whether to ignore executors.  
Public Property Flag to control the visibility of the command in Customization dialog.  
Public Property Gets the IsValid status of the command. A Command may become invalid in some application contexts.  
Public Property The commands key in the CommandCollection.  
Public Property ArrayList which can contain data to be presented in the GUI.  
Public Property Gets or sets a value indicating whether the command should run in background.  
Public Property Used to communicate to the command which item in the list was selected.  
Public Property Setting this value will set the CommandExecutor.Value property on all attached CommandExecutors.  
Public Property True if the value of the command has been changed.  
Public Property Gets or sets if the command is visible. Setting this value will set the CommandExecutor.Visible property on all attached CommandExecutors.  
Top
Public Methods
 NameDescription
Public Method Attaches a CommandExecutor derived class to the command.  
Public MethodOverloaded.  Version of Execute which can be cancelled by an BeforeCommandExecute event handler and which takes arguments.  
Public Method Detach all CommandExecutor derived classes from the command.  
Public Method Detach a CommandExecutor derived class from the command.  
Public MethodOverloaded.  The command Execute method which takes arguments, and calls a matching Execute in a derived class.  
Public Method Finds a matching execute overload.  
Public Method Gets the current state of the command.  
Public MethodOverloaded.  Call to allow the command to update its visibility or enabled state following a change to system.  
Public Method Select the executors (e.g. for Context Tabs)  
Public Method Sets a property.  
Top
Public Events
 NameDescription
Public Event Occurs before the command is executed.  
Public Event Occurs when the command is executed.  
Top
See Also