Table of Contents

HELP event

Description

Programmer defined; usually occurs when user selects a menu item or uses an accelerator key combination to get additional information.

Syntax

bforward = HELP(ctrlentID, ctrlclassID)

Parameters

HELP accepts arguments for the following parameters.

ParameterDescription
ctrlentIDHas the format WindowName.ControlName, where WindowName is the identifier of the window that contains the affected control, and ControlName is the identifier of that control. Notice that a period separates the two values.
ctrlclassIDThe type of control. Possible values are:

Type - Description
BMP - Bitmap.
CHECKBOX - Check box.
COMBOBOX - Combo box.
EDITBOX - Edit box.
EDITFIELD - Edit line.
EDITTABLE - Edit table.
GROUPBOX - Group box.
HSCROLL - Horizontal scroll bar.
ICON - Icon.
LISTBOX - List box.
MENU - Menu.
PUSHBUTTON - Push-button.
RADIOBUTTON - Radio button.
STATIC - Text.
VSCROLL - Vertical scroll bar.
WINDOW - Window.

Returns

True or false. If false, the program execution returns to the calling procedure. If true, the event processing goes to the next level.

Remarks

Often, QuickHelp is tied to the HELP event using a QuickEvent.