View_File_Help - HelpSystem
Sent when the requesting object has requested help about a database file
Type: Procedure
Parameters
| Parameter | Type | Description |
|---|---|---|
| Obj | Integer | The object ID of the object that is requesting help |
Syntax
Procedure View_File_Help Integer Obj
Call Example
Send View_File_Help Obj
Description
The requesting object (Obj) has requested help about a database file. The file and field value must be obtained from the requesting object by sending it the message help_context. Unless modified, the function help_context will return the file and field as a string in file.field format or as a blank if there is no file.
This value needs to be processed one more level before it can be used as a help context value. It does this by calling the help_object function, system_help_file_ID. This function is passed the file.field string and is expected to return an appropriate context value (ID or keyword) for this file and field. The purpose of this function is to translate the DataFlex context (a file and a field) into help context. By default, it returns the file number (ignoring the field) or, if the file was 0, the help_ID_files property value. This assumes that the help file's topic ID will be the same as the file's file-list number.
This mechanism provides context support to the file-number level. It would require that users navigate within the help file to find documentation on a particular field. If you wish context support at the file and field level you will need to program this yourself.