COMMAND Object
- Last UpdatedMar 24, 2023
- 1 minute read
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 five 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 |
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 -->