Software Customisation
Reference Manual
Summary of Objects, Members and Methods
:
Object Type Details
: COMMAND Object
COMMAND Object
Member
Name
Type
Purpose
Execute
STRING Get/Set
Execute callback called when command executed
Key
STRING Get/Set
Command unique key
List
STRING Get/Set
List callback returns ARRAY for List or ComboBox tools
Refresh
STRING Get/Set
Refresh callback called when application context is changed
RefreshFilters
ARRAY (STRING)
Get/Set
An ARRAY of up to 5 STRINGs used to filter refresh callback
State
STRING Get/Set
State callback returns command state which can be
'Enabled', 'Disabled', 'Hidden', 'Checked' or 'Unchecked'
Methods
Name
Result
Purpose
Checked()
BOOLEAN
Get command checked state
Checked(BOOLEAN state)
NO RESULT
Set command checked state
ExecuteOnChecked()
BOOLEAN
Get whether to execute command when setting checked
ExecuteOnChecked(BOOLEAN state)
NO RESULT
Get whether to execute command when setting checked
Enabled()
BOOLEAN
Get command enabled state
Enabled(BOOLEAN state)
NO RESULT
Set command enabled state
Register()
NO RESULT
Registers command with the Command Manager
Select()
NO RESULT
Select tool attached to command
SelectedIndex()
REAL
Get list command selected index
SelectedIndex(REAL index)
NO RESULT
Sets list command selected index
Value()
STRING
Gets command value
Value(REAL val)
NO RESULT
Sets command value
Value(STRING val)
NO RESULT
Sets command value
Value(BOOLEAN val)
NO RESULT
Sets command value
Visible()
BOOLEAN
Gets command visibility
Visible(BOOLEAN val)
NO RESULT
Sets command visibility
Command
>--SETUP COMMAND fname NL--+--KEY text --* command key
|\ |
| '-----<-----'
|
+--EXIT -->
1974 to current year.
AVEVA Solutions Limited and its subsidiaries. All rights reserved.