Help_Id - FloatingPanel

Used to specify an object's context ID

Type: Property

Access: Read/Write

Data Type: Integer

Parameters: None

Syntax
 Property Integer Help_Id

Read Access: Get Help_Id to IntegerVariable
Write Access: Set Help_Id to IntegerVariable/Value


Description

This property is used to specify an object's context ID. You must set it.

Note:
Using Help_Ids is becoming a less frequently used technique as it requires an intermediate step that is not rquired when using a psHtmlHelpTopic. Using Help_Ids requres setting up an intermediate file that "translates" the Help_Id to an actual help page. If you are using Compiled HTML Help (via the cHtmlHelp class) rather than the obsolete WinHelp, we recommend using psHtmlHelpTopic instead of Help_Id.


When help is invoked by sending the message help to an object, the object will try to find a context. It will first check to see if the object has a Help_Id assigned. If not, it will check to see if a Help_Keyword has been assigned. If both are unassigned it will delegate and check to see if context is provided for the parent object. This continues until a help context is provided or there are no more parent objects. This allows you to define your context help at a very specific level (the object) to a very general level (the view or the application)

One would rarely mix Help_Id and Help_Keyword contexts within a single application.

Usually the context IDs are defined in advance and represented as symbolics.

#REPLACE HLP_Vendor_Address_Help  2020
:
Object Vendor_Address is a dbForm
    Set Location to 10 70
    Set Size to 13 100
    Entry_Item Vendor.Address
    Set Label to "Address"
    Set Help_id to HLP_Vendor_Address_Help
End_Object