Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Engineering

BAR Gadget

  • Last UpdatedMar 24, 2023
  • 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 pull-down menu.

The name of the pull-down menu is given in menu; the DTEXT of the field is given by dText.

Clear()

NO RESULT

Removes all barmenu fields.

Note:
Using this method is deprecated.

Clear(STRING dText)

NO RESULT

Removes all barmenu fields after and including the one with the DTEXT dText.

Note:
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, e.g. "!!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, i.e. "bar"

Owner()

FORM

Get the owning form.

SetActive( STRING dText, BOOLEAN state)

NO RESULT

Deactivate/Activate the menu field whose DTEXT is dText.

Note:
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.

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 "Add()" method of the bar.

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.

Related Links
TitleResults for “How to create a CRG?”Also Available in