HelpSearchCommand Class Members
The following tables list the members exposed by HelpSearchCommand.
Public Constructors
Name | Description | |
---|---|---|
HelpSearchCommand Constructor | Default constructor. |
Public Fields
Name | Description | |
---|---|---|
messageDisplayed | true if message displayed. (Inherited from Aveva.ApplicationFramework.Presentation.Command) |
Public Properties
Name | Description | |
---|---|---|
AllowWaitCursor | Get/Set AllowWaitCusor value. (Inherited from Aveva.ApplicationFramework.Presentation.Command) | |
ApplicationContext | Application context for which this command is valid. (Inherited from Aveva.ApplicationFramework.Presentation.Command) | |
AttachedExecutorsCount | Get the number of CommandExecutors attached to the command (Inherited from Aveva.ApplicationFramework.Presentation.Command) | |
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. (Inherited from Aveva.ApplicationFramework.Presentation.Command) | |
ContextObjectKey | Key to Context object. (Inherited from Aveva.ApplicationFramework.Presentation.Command) | |
Description | Description for the command. (Inherited from Aveva.ApplicationFramework.Presentation.Command) | |
Enabled | Gets or sets if the command is enabled. Setting this value will set the CommandExecutor.Enabled property on all attached CommandExecutors. (Inherited from Aveva.ApplicationFramework.Presentation.Command) | |
ExecuteOnCheckedChange | Gets or sets a value indicating whether the execute on checked change. (Inherited from Aveva.ApplicationFramework.Presentation.Command) | |
Executes | Get all command Execute overloads. (Inherited from Aveva.ApplicationFramework.Presentation.Command) | |
IgnoreExecutors | Gets a value indicating whether to ignore executors. (Inherited from Aveva.ApplicationFramework.Presentation.Command) | |
Internal | Flag to control the visibility of the command in Customization dialog. (Inherited from Aveva.ApplicationFramework.Presentation.Command) | |
IsValid | Gets the IsValid status of the command. A Command may become invalid in some application contexts. (Inherited from Aveva.ApplicationFramework.Presentation.Command) | |
Key | The commands key in the CommandCollection. (Inherited from Aveva.ApplicationFramework.Presentation.Command) | |
List | ArrayList which can contain data to be presented in the GUI. (Inherited from Aveva.ApplicationFramework.Presentation.Command) | |
RunInBackground | Gets or sets a value indicating whether the command should run in background. (Inherited from Aveva.ApplicationFramework.Presentation.Command) | |
SelectedIndex | Used to communicate to the command which item in the list was selected. (Inherited from Aveva.ApplicationFramework.Presentation.Command) | |
Value | Setting this value will set the CommandExecutor.Value property on all attached CommandExecutors. (Inherited from Aveva.ApplicationFramework.Presentation.Command) | |
ValueChanged | True if the value of the command has been changed. (Inherited from Aveva.ApplicationFramework.Presentation.Command) | |
Visible | Gets or sets if the command is visible. Setting this value will set the CommandExecutor.Visible property on all attached CommandExecutors. (Inherited from Aveva.ApplicationFramework.Presentation.Command) |
Public Methods
Name | Description | |
---|---|---|
AttachExecutor | Attaches a CommandExecutor derived class to the command. (Inherited from Aveva.ApplicationFramework.Presentation.Command) | |
CancelableExecute | Overloaded. Version of Execute which can be cancelled by an BeforeCommandExecute event handler and which takes arguments. (Inherited from Aveva.ApplicationFramework.Presentation.Command) | |
DetachAllExecutors | Detach all CommandExecutor derived classes from the command. (Inherited from Aveva.ApplicationFramework.Presentation.Command) | |
DetachExecutor | Detach a CommandExecutor derived class from the command. (Inherited from Aveva.ApplicationFramework.Presentation.Command) | |
Execute | Overloaded. Overridden. The command Execute method is normally overridden by a derived class. | |
FindExecute | Finds a matching execute overload. (Inherited from Aveva.ApplicationFramework.Presentation.Command) | |
GetState | Gets the current state of the command. (Inherited from Aveva.ApplicationFramework.Presentation.Command) | |
Refresh | Overloaded. Call to allow the command to update its visibility or enabled state following a change to system. (Inherited from Aveva.ApplicationFramework.Presentation.Command) | |
Select | Select the executors (e.g. for Context Tabs) (Inherited from Aveva.ApplicationFramework.Presentation.Command) | |
SetProperty | Sets a property. (Inherited from Aveva.ApplicationFramework.Presentation.Command) |
Public Events
Name | Description | |
---|---|---|
BeforeCommandExecute | Occurs before the command is executed. (Inherited from Aveva.ApplicationFramework.Presentation.Command) | |
CommandExecuted | Occurs when the command is executed. (Inherited from Aveva.ApplicationFramework.Presentation.Command) |
See Also