SHOWHELP()

From Lianjapedia
Revision as of 08:09, 20 March 2013 by Yvonne.milne (Talk | contribs)

Jump to: navigation, search

Purpose

Function to display help information in a popup Help dialog

Syntax

SHOWHELP(<expC1>, <expC2> [, <expC3> [, <expL>]])

See Also

GETFILE(), SHOWDOCUMENT()

Description

The SHOWHELP() function displays help information in a popup dialog.

Parameter Description
<expC1> Help dialog title
<expC2> Help table name.
The table should have the following structure:
HELPTOPIC Character(60) Description 'Help topic'
HELPTEXT Memo Description 'Help text'
and the following index tag:
Tag: HELPTOPIC
Key: helptopic
<expC3> Help topic. SHOWHELP() will search for this topic in the Help table's index and display the text from the HELPTEXT memo field. If the topic is not found, a message will be displayed in the Help dialog: 'No help found for the specified topic.' If <expC3> is not specified, the first record (in the index) from the Help table will be displayed.
<expL> Show buttons flag. If <expL> is .T. navigation buttons to move between Help topics will be displayed at the bottom of the dialog. If <expL> is .F. or not specified, no buttons are displayed.

The SHOWHELP() functionality is also provided in the Lianja system object showhelp() method.

Example

open database southwind
showhelp("Help for Employees Page","lianjademo_help","page_employees",.T.)