Help

Help$

Specifies the text displayed in the status bar when the control gets focus

String property

Applies to: Generic , Grid , GridCell , MenuItem

Help() Event

Called whenever the user presses F1 and there is no other handler.

Applies to: Form

Introduced in KCML version 7.07

Help

Event

This event will be triggered when a user presses the F1 key while viewing a form, assuming the F1 key does not already have a handler. If there is already a handler, pressing the F1 key will execute the existing handler, and this event will not be triggered.

Property

This property is used to provide additional help for the control in the form of tool tips or as a message in the status bar pane, if it exists. When the mouse pointer hovers over the control a small box appears containing the help text. If a Status bar exists on the form then the contents of Help$ are placed in the first pane of the Status bar when the control gets focus. The default help text for a control can be changed within the program, for example:

.listControl1.Help$ = "Used to enter useful information"

Note that the status bar is not updated until the current event handler has completed. To immediately update the status bar you should call the Flush() method after the Help$ property has been changed.

Menu

This associates a string with the menu item on the main menu bar and when that item is selected in the menu the .Help$ string will be displayed on any status bar control. This allows the menu text to be terse as a more detailed explanation will be visible on the status bar while that item has focus.

 .FileMenu.SaveOpt.Help$ = "Save the current program to disk"

See also

Form methods, properties and events. Generic methods, properties and events. Grid methods, properties and events. GridCell methods, properties and events. MenuItem methods, properties and events.