OPTION Gadget

DText

ARRAY OF

STRING Get/Set

Set or get the entire list of display texts.

DText[n]

STRING

Get Only

Get the display text of the n'th option.

RText

ARRAY OF

STRING Get/Set

Set or get the list of replacement texts.

RText[n]

STRING

Get Only

Get the replacement text of the n'th option.

Count

REAL

Get only

Get count of number of fields in the list.

Val

REAL

Get/Set

Selected field as integer.

Zero implies no selection.

Setting val to zero will cause an error if ZeroSel is not specified.

Add(STRING Dtext)

NO RESULT

Append an entry to the drop-down list, where Dtext is the text to display in the option list.

Add(STRING Dtext, STRING Rtext))

NO RESULT

Append and entry to the drop-down list, where Dtext is the text to display in the option list, and Rtext is the replacement text for the new field.

If Rtext is not specified, it will be set to Dtext by default.

Clear()

NO RESULT

Clear gadget’s contents.

ClearSelection()

NO RESULT

Clears selection and returns to default of first in list.

FullName()

STRING

Get the full gadget name, for example, '!!Form.gadget'.

Name()

STRING

Get the gadget's name, for example, 'gadget'.

Owner()

FORM

Get owning form.

Select(STRING text, STRING value )

NO RESULT

Select specified item in a list: text must be ‘Rtext’ or ‘Dtext’, and value is the item to be selected.

Selection()

STRING

Get current selection’s RTEXT.

Selection(STRING text )

STRING

Get RTEXT or DTEXT of current selection; text must be 'Rtext' or 'Dtext'.

SetPopup(MENU menu)

NO RESULT

Links menu with the gadget as a pop-up.

Refresh()

NOT RESULT

Refreshes the display of the gadget.

SetFocus()

NO RESULT

Move keyboard focus to this gadget.

RemovePopup(MENU menu)

NO RESULT

Removes (pop-up) menu from the gadget.

GetPickedPopup()

MENU

Returns the last picked pop-up menu for the gadget.

Shown()

BOOLEAN

Get ‘shown’ status.

Type()

STRING

Get the gadget type as a string.

Background()

STRING

Get Background Color Name.

Some gadgets do not support this property in all circumstances, for example, gadgets which are showing a pixmap.

Gadgets whose color has not been set explicitly, may not have a color with a known colorname. In this case an error is raised.

DisplayText( )

STRING

Gets the text string currently displayed in the Option gadget's display field.

SetPopup( !menu )

NO RESULT

Assigns a menu object as the gadget's current pop-up.

Clear( !dtext )

NO RESULT

Delete the field with the given DTEXT string.

Clear( !fieldNumber )

NO RESULT

Delete the specified field number.