IAssistance.ShowHelp Method

Displays the help topic specified by its ID in the Office Help Viewer or, for help topics that ship with Office, in the Help window of the current Office application.

Namespace:  Microsoft.Office.Core
Assembly:  office (in office.dll)

Syntax

'Declaration
Sub ShowHelp ( _
    HelpId As String, _
    Scope As String _
)
'Usage
Dim instance As IAssistance
Dim HelpId As String
Dim Scope As String

instance.ShowHelp(HelpId, Scope)

void ShowHelp(
    string HelpId,
    string Scope
)

Parameters

• HelpId
  Type: System.String

  Optional, the ID of the help topic.

• Scope
  Type: System.String

  Optional, the namespace registered within the host application.

Remarks

The Assistance property of an Application object 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.

The following scopes are available within the Microsoft Office applications. By default, the scope is set to the current application's namespace if a Null string ("") is passed as a parameter.

Applications	Scope Parameter
All	"" (Null string)
Access, Excel, Outlook, PowerPoint, Project, Publisher, SharePoint Designer, Visio, and Word	DEV

See Also

Reference

IAssistance Interface

IAssistance Members

Microsoft.Office.Core Namespace