IAssistance.SearchHelp Method
Performs a search from the Office Help Viewer based on one or more keywords. Keywords can be a word or a phrase.
Namespace: Microsoft.Office.Core
Assembly: office (in office.dll)
Syntax
'Declaration
Sub SearchHelp ( _
Query As String, _
Scope As String _
)
'Usage
Dim instance As IAssistance
Dim Query As String
Dim Scope As String
instance.SearchHelp(Query, Scope)
void SearchHelp(
string Query,
string Scope
)
Parameters
Query
Type: System.StringRepresents the search keyword or phrase.
Scope
Type: System.StringOptional, 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 user can return more relevant help by narrowing the scope of the search, as long as the specified scope is applicable to the application. The following scopes are available within 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 |