BBjWindow::getListBox

Description

In BBj 7.0 and higher, this method returns a BBjControl object in the BBjWindow cast to a BBjListBox.

In BBj 11.0 and higher, this method supports reference to the BBjListBox by name with a (string name) parameter.

Syntax

Return Value

Method

BBjListBox

getListBox(int controlID)

BBjListBox

getListBox(string name)

Parameters

Parameter Description
controlID Specifies the ID of the control. A value of 0 may be used to get information about a context's window or dialog rather than an individual control or child window (as defined in the CTRL() function).
name Specifies name given to a BBj control using the setName method.

Return Value

This convenience method calls getControl() and casts the result to a BBjListBox.

Remarks

If the control that generated this event is not a BBjListBox, this method will generate an !ERROR=26.

See Also

String Templates

BBjAPI

See the BBj Object Diagram for an illustration of the relationship between BBj Objects.