Helpcontextid property

Applies to

BoundObjectFrame Object	Image Object	Page Object
CheckBox Object	Label Object	Report Object
ComboBox Object	ListBox Object	TabControl Collection
CommandButton Object	ObjectFrame Object	TextBox Object
CustomControl Object	OptionButton Object	ToggleButton Object
Form Object	OptionGroup Object

The HelpContextID property specifies the context ID of a topic in the custom Help file specified by the HelpFile property setting. Read/write Long.

expression.HelpContextId

expression Required. An expression that returns one of the objects in the Applies To list.

Remarks

Note: If you enter the context ID of the Help file topic as a positive number, the help topic will display in a "full" help topic window. If you add a minus sign ("-") in front of the context ID, the help topic will be displayed in a "pop-up" window. It is important to note that the context ID is not required to have a negative number when the topic is authored in Microsoft Help Workshop. You must add the minus sign when setting the property to make the article display in the pop-up window.

You can create a custom Help file to document forms, reports, or applications you create with Microsoft Office Access 2007.

When you press the F1 key in Form view, Access calls the Microsoft Help Workshop or Microsoft HTML Help Workshop application, loads the custom Help file specified by the HelpFile property setting for the form or report, and displays the Help topic specified by the HelpContextID property setting.

If a control's HelpContextID property setting is 0 (the default), Access uses the form's HelpContextID and HelpFile properties to identify the Help topic to display. If you press F1 in a view other than Form view or if the HelpContextID property setting for both the form and the control is 0, an Access Help topic is displayed.

Example

This example uses the HelpContext property of the Err object to show the Visual Basic for Applications (VBA) Help topic for the Overflow error.

Dim Msg
Err.Clear
On Error Resume Next
Err.Raise 6 ' Generate "Overflow" error.
If Err.Number <> 0 Then
    Msg = "Press F1 or HELP to see " & Err.HelpFile & _
        " topic for" & _
    " the following HelpContext: " & Err.HelpContext
    MsgBox Msg, , "Error: " & Err.Description, _
        Err.HelpFile, Err.HelpContext
End If