|
|
Visits:
2391
(72 on line)
|
Last Update: Dec 22, 2003
|
|
|
|
|
| | |
| Description Inheritance Example Properties Methods |
| |
| Description |
The THelp5 Object is used for calling and displaying a Help File or Help File Topic under program control from APL+Win
Windows Help Files (.HLP) and HTML Help Files (.CHM) are supported
You may open the Help File on a particular Topic using the <keyword> property |
| Description Inheritance Example Properties Methods |
| |
| Inheritance |
Inherits from: TObject5 |
| Description Inheritance Example Properties Methods |
| |
| Example |
| |
 |
| |
The above form is generated by the following APL+Win Objects™ code: |
'help'Świ'*Create' 'THelp5'('file'(('oo5'Świ'apldir'),'aplgui.hlp'))('type'257)('keyword' 'Form')'ShowHelp'
'help'Świ'*Create' 'THelp5'('file'(('oo5'Świ'installdir'),'objects5.chm'))'ShowHelp'
|
| |
| Description Inheritance Example Properties Methods |
| |
| Properties |
| |
|
| class |
Description: Return current object class
Syntax: class„'obj' Świ 'class' |
| file |
Description: Get or Set the help file name wanted
Syntax: 'obj' Świ 'file'filename
filename: complete DOS file name of help file wanted
Example:
'help' Świ 'file' (('oo5' Świ 'installdir'),'objects5.chm') |
| handle |
Description: Get or Set the handle of the window requesting help
Syntax: 'obj' Świ 'handle'hwnd
hwnd: a window handle (default to 0)
Example:
'help' Świ 'handle' ('ff' Świ '*hwnd') |
| help |
Example:
0 0˝'help' Świ '*Create' 'THelp5' ('file' (('oo5' Świ 'apldir'),'aplgui.hlp')) ('type'257) ('keyword' 'Form') 'ShowHelp'
© or:
0 0˝'help' Świ '*Create' 'THelp5' ('file' (('oo5' Świ 'installdir'),'objects5.chm')) 'ShowHelp' |
| keyword |
Description: Get or Set the keyword of context to be sought in help file
Syntax: 'obj' Świ 'keyword'context
context: a keyword character string (default to '')
Example:
'help' Świ 'keyword' 'Form' |
| type |
Description: Get or set type of help wanted
1:HELP_CONTEXT - Display help for a context
2:HELP_QUIT - Shut down the help system
3:HELP_INDEX - Display the index of the help file
4:HELP_HELPONHELP - Display help for Help itself
5:HELP_SETINDEX - Set the current index to the specified context
257:HELP_KEY - Display help for the specified file and keyword
261:HELP_PARTIALKEY - Display list of topics beginning with a keyword
513:HELP_MULTIKEY - Display help for a keyword in alt keyword table
Example:
'help' Świ 'type'257 |
|
| Description Inheritance Example Properties Methods |
| |
| Methods |
| |
|
| New |
Description: Create a new instance of THelp5
Example:
'obj' Świ '*Create' 'THelp5'
|
| ShowHelp |
Description: Display help file
Syntax: boolean„'obj' Świ 'ShowHelp'
boolean: 1=success, 0=failure
NOTE: you must set the 'file' and optionnaly 'keyword' 'handle' & 'type'
properties before calling ShowHelp
Example:
'help' Świ 'ShowHelp' |
|
| Description Inheritance Example Properties Methods |
| |
|
THelp5 