BBjWindow::getGridHeader

Description

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

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

Syntax

Return Value	Method
BBjGridHeader	getGridHeader(int controlID)
BBjGridHeader	getGridHeader(string name)

Parameters

Variable	Description
controlID	Specifies the ID of the control.
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 BBjGridHeader.

Remarks

If the control is not a BBjGridHeader, this method will generate an !ERROR=26.

See Also

BBjAPI

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