Help

Description

Occurs when the user drags the question-mark button from the title bar to a menu item or a control and then clicks, or when the user clicks in a control (giving it focus) and then presses the F1 key.

Event ID

Event ID

Objects

pbm_help

Window, Menu, DragObject


Arguments

Argument

Description

xpos

Integer by value (the distance of the Help message from the left edge of the screen, in PowerBuilder units)

ypos

Integer by value (the distance of the Help message from the top of the screen, in PowerBuilder units)


Return Values

Long.

Return code choices (specified in a RETURN statement):

0 -- Continue processing

Usage

The question-mark button only appears in the title bar of response windows. You must set the ContextHelp property to true to enable this event.

You can script Help messages for individual menu items and controls. PowerBuilder dispatches the associated Windows message to the appropriate menu item or control.

Examples

This example codes a message box to open when the user drags and clicks the question-mark button over a TrackBar control:

MessageBox("Context Help Message", "Move the TrackBar" &
 + " slider to~r~n change the DataWindow magnification.")

See also

ShowHelp