BAR Gadget
- Last UpdatedNov 10, 2025
- 2 minute read
Methods
|
Name |
Result |
Purpose |
|---|---|---|
|
Add(STRING dText, STRING enu) |
NO RESULT |
Appends a barmenu field, which can show the specified menu as a pulldown menu. The name of the pulldown menu is given in menu; the DTEXT of the field is given by dText. |
|
Clear() |
NO RESULT |
Removes all barmenu fields. Using this method is deprecated. |
|
Clear(STRING dText) |
NO RESULT |
Removes all barmenu fields after and including the one with DTEXT dText. Using this method is deprecated. |
|
FieldProperty(STRING field, STRING property) |
BOOLEAN |
Get the value of the property named in property for the menu field named in field. The allowed values for the property are 'ACTIVE' or 'VISIBLE'. |
|
FullName() |
STRING |
Get the full name of the gadget, for example,'!!Form.bar'. |
|
InsertAfter(STRING field, STRING dText, STRING menu) |
NO RESULT |
Inserts a new barmenu field immediately after the one identified by field. The name of the menu is given in menu; the DTEXT of the new field is given by dText. |
|
InsertBefore(STRING field, STRING dText, STRING menu) |
NO RESULT |
Inserts a new barmenu field immediately before the one identified by field. The name of the menu is given in menu; the DTEXT of the menu is given by dText. |
|
Name() |
STRING |
Get the gadget's name, that means, 'bar'. |
|
Owner() |
FORM |
Get the owning form. |
|
SetActive( STRING dText, BOOLEAN state) |
NO RESULT |
Deactivate/Activate the menu field whose DTEXT is dText. Using this method is deprecated. |
|
SetFieldProperty(STRING menu, STRING property, BOOLEAN state) |
NO RESULT |
Set the value of the property named in property with the value of state, for the menu named in menu. The allowed values for the property are 'ACTIVE' or 'VISIBLE'. |
|
Shown() |
BOOLEAN |
Get shown status. |
|
Type() |
STRING |
Get the GADGET type as a STRING. |
Table 2: 18. BAR Object Methods
Command
The BAR command creates a bar menu within a form definition.
The recommended way to create menu fields on the bar is to use the bar's Add() method.
bar
!this.bar.add ( 'Choose', 'Menu1')
!this.bar.add ( ' window', 'Window' )
!this.bar.add ( 'help', 'Help' )
Note: The use of the two special menu names 'Help', which adds a system help menu that calls the online help; and 'Window', which adds a system Window menu that lists all the displayed windows.