IAssistance.ClearDefaultContext Method

Office Developer Reference

Clears the default help topic previously defined in the SetDefaultContext method.

Syntax

expression.ClearDefaultContext(HelpId)

expression   An expression that returns a IAssistance object.

Parameters

Name Required/Optional Data Type Description
HelpId Required String The ID of the default help topic.

Remarks

Executing this method will stop the default help topic from displaying when the user presses F1 or clicks the Help button in a dialog box.

The Assistance property returns an IAssistance object. The IAssistance object exposes methods that allow developers to display help topics in the Office Help Viewer or to display help topics that ship with Office in the Help window of the host application. Developers either pass specific Help IDs to the help system or pass specific search queries. Help IDs have to be explicitly added to the Help file in order for the Help ID to return the help topic.

Example
In the following example, the default help topic is cleared and will no longer displayed.

Visual Basic for Applications
  Sub ClearDefaultHelpTopic()
   Application.Assistance.ClearDefaultContext "22261"
End Sub

See Also