BBjWindow::getListButton

 

Description

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

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

Syntax

Return Value

Method

BBjListButton

getListButton(int controlID)

BBjListButton

getListButton(string name)

Parameters

Return Value

Method

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 BBjListButton.

Remarks

If the control that generated this event is not a BBjListButton, 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.