BBjControl::getToolTipText

Description

Returns the tooltip text for the BBjControl (also known as short cue in BBx).

Syntax

Return Value

Method

string

getToolTipText()

Parameters

None.

Return Value

Returns the tool tip text when the mouse is positioned over the control.

Remarks

Same as BBjControl::getShortCue.

Example

REM Get the tooltip text of a control

REM Obtain the instance of the BBjAPI object
LET myAPI!=BBjAPI()

REM Open the SysGui device
SYSGUI=UNT
OPEN (SYSGUI) "X0"

REM Obtain the instance of the BBjSysGui object
LET mySysGui!=myAPI!.getSysGui()

REM Set common addWindow param values
X=10
Y=10
WIDTH=200
HEIGHT=200

REM Create a window with a title in the current context
TITLE$="BBj Window"
REM Set the current context
mySysGui!.setContext(0)
myWindow! = mySysGui!.addWindow(X,Y,WIDTH,HEIGHT,TITLE$)

REM Add a button on the window
myButton! = myWindow!.addButton(101,50,100,90,30,"Button")

REM Set the tooltip text for the button
myButton!.setToolTipText("This is a tooltip")

REM Get the tooltip text for the button
TOOLTIP_TEXT$=myButton!.getToolTipText()

REM Register the CALLBACK routines
CALLBACK(ON_CLOSE,APP_CLOSE,mySysGui!.getContext())

REM Process Events
PROCESS_EVENTS

REM Callback routine called when the user closes the application window
APP_CLOSE:
RELEASE
RETURN

See Also

BBjAPI

BBjSysGui

BBjWindow

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