Help2 Interface
The interface that supports Document Explorer.
Namespace: Microsoft.VisualStudio.VSHelp80
Assembly: Microsoft.VisualStudio.VSHelp80 (in Microsoft.VisualStudio.VSHelp80.dll)
Syntax
'Declaration
<GuidAttribute("78413D2D-0492-4A9B-AB25-730633679977")> _
Public Interface Help2 _
Inherits Help
[GuidAttribute("78413D2D-0492-4A9B-AB25-730633679977")]
public interface Help2 : Help
[GuidAttribute(L"78413D2D-0492-4A9B-AB25-730633679977")]
public interface class Help2 : Help
[<GuidAttribute("78413D2D-0492-4A9B-AB25-730633679977")>]
type Help2 =
interface
interface Help
end
public interface Help2 extends Help
The Help2 type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
Collection | Returns the name of the current collection loaded. (Inherited from Help.) |
|
Collection | Infrastructure. Microsoft Internal Use Only. |
|
Filter | Gets or sets the collection filter. (Inherited from Help.) |
|
Filter | Gets or sets the collection filter. |
|
FilterQuery | Returns the filter query string for the current Help collection filter. (Inherited from Help.) |
|
FilterQuery | Returns the query string for the current Help collection filter. |
|
Help | Used for compatibility with DTE2, when used as Windows.External, Help2 object returns itself. (Inherited from Help.) |
|
Help | Used for compatibility with DTE2, when used as Windows.External, Help2 object returns itself. |
|
HelpOwner | Gets or sets the help owner. (Inherited from Help.) |
|
HelpOwner | Infrastructure. Microsoft Internal Use Only. |
|
HxSession | Returns the HxSession object. (Inherited from Help.) |
|
HxSession | Infrastructure. Microsoft Internal Use Only. |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
AskAQuestion | Displays a URL based on the supplied flag. |
|
CanShowFilterUI() | Do not use. (Inherited from Help.) |
|
CanShowFilterUI() | Deprecated method. |
|
CanSyncContents(String) | Determines if a URL can be synchronized to or not. (Inherited from Help.) |
|
CanSyncContents(String) | Determines if a URL can be synchronized to or not. |
|
Close() | Closes the Microsoft Document Explorer window and all of its pages. (Inherited from Help.) |
|
Close() | Closes Document Explorer and all of its pages. |
|
Contents() | Selects the Contents navigation window and opens it if it is closed. (Inherited from Help.) |
|
Contents() | Selects the Contents navigation window and opens it if it is closed. |
|
DisplayTopicFrom_OLD_Help(String, UInt32) | Provides support for .chm and .hlp files. (Inherited from Help.) |
|
DisplayTopicFrom_OLD_Help(String, UInt32) | Deprecated method. Use DisplayTopicFromF1Keyword instead. |
|
DisplayTopicFromF1Keyword(String) | Provides F1 Help for a modal or non-modal dialog box. (Inherited from Help.) |
|
DisplayTopicFromF1Keyword(String) | Displays Help for F1 and from dialog boxes. |
|
DisplayTopicFromId(String, UInt32) | Finds and displays the first topic defined by the supplied F1 keyword and context help ID. (Inherited from Help.) |
|
DisplayTopicFromId(String, UInt32) | Deprecated. Use DisplayTopicFromF1Keyword instead. |
|
DisplayTopicFromKeyword(String) | Performs a lookup by using the K-keyword index. (Inherited from Help.) |
|
DisplayTopicFromKeyword(String) | Performs a lookup by using the K-keyword index. |
|
DisplayTopicFromURL(String) | Displays a help topic specified by the URL in Document Explorer. (Inherited from Help.) |
|
DisplayTopicFromURL(String) | Displays a Help topic specified by the URL in Document Explorer. |
|
DisplayTopicFromURLEx(String, IVsHelpTopicShowEvents) | Displays a help topic in Document Explorer and triggers a specified event after the topic has been loaded. (Inherited from Help.) |
|
DisplayTopicFromURLEx(String, IVsHelpTopicShowEvents) | Infrastructure. Microsoft Internal Use Only. |
|
DisplayTopicFromURLEx2 | Displays a Help topic in Document Explorer that is based on help display flags. |
|
Favorites | Displays the Favorites tool window. |
|
FilterUI() | Displays the user interface to create, edit, or delete filters. (Inherited from Help.) |
|
FilterUI() | Deprecated method. |
|
GetNextTopic(String) | Given a URL returns the next URL in the table of contents. (Inherited from Help.) |
|
GetNextTopic(String) | Given a URL returns the next URL in the table of contents. |
|
GetObject(String, String) | Infrastructure. Microsoft Internal Use Only. (Inherited from Help.) |
|
GetObject(String, String) | Infrastructure. Microsoft Internal Use Only. |
|
GetPrevTopic(String) | Given a URL returns the previous URL in the table of contents. (Inherited from Help.) |
|
GetPrevTopic(String) | Given a URL returns the previous URL in the table of contents. |
|
HowDoI | Shows the How Do I window. |
|
Index() | Selects the Index window. (Inherited from Help.) |
|
Index() | Selects the Index window. |
|
IndexResults() | Selects the Index Results window. (Inherited from Help.) |
|
IndexResults() | Selects the Index Results window. |
|
InitializeSettingsToken | Infrastructure. For Microsoft Internal Use Only. |
|
Search() | Selects the Search dialog box. (Inherited from Help.) |
|
Search() | Selects the Search dialog box. |
|
SearchEx | Selects the Search window and optionally fills the Search dialog box with a term or executes a search for a specific term. |
|
SearchResults() | Selects the Search Results window. (Inherited from Help.) |
|
SearchResults() | Selects the Search Results window. |
|
SetCollection(String, String) | Loads a Help collection into Document Explorer. (Inherited from Help.) |
|
SetCollection(String, String) | Infrastructure. Microsoft Internal Use Only. |
|
SyncContents(String) | Synchronizes the table of contents to the supplied URL. (Inherited from Help.) |
|
SyncContents(String) | Synchronizes the table of contents to the supplied URL. |
|
SyncIndex(String, Int32) | Looks up the topic specifies by the K-keyword but does not display the topic in Document Explorer, unless specified. (Inherited from Help.) |
|
SyncIndex(String, Int32) | Looks up the topic specified by the K-keyword, but it does not display the topic in Document Explorer, unless specified. |
Top
Remarks
Help2 supports How Do I, Search, and Favorites. It is the main entry point for accessing Document Explorer (Dexplorer.exe).
How you obtain the Help2 object depends on the application.
In non-VSPackages:
The Help2 object is a child of DTE in its object hierarchy and can be accessed by using the late-bound DTE.Help property. To access Help2 in an application that is not an add-in or a macro, you must obtain an instance of DTE, which is illustrated by the following example:
EnvDTE.DTE dte; dte = (EnvDTE.DTE)System.Runtime.InteropServices.Marshal.GetActiveObject("VisualStudio.DTE.8.0"); Object helpobj = dte.Help;In an add-in you can obtain the Help2 object directly:
Microsoft.VisualStudio.VSHelp80.Help2 help2 = (Microsoft.VisualStudio.VSHelp80.Help2)dte.GetObject("Help2");
In a VSPackage:
You obtain the Help2 object through SVsHelp service:
Microsoft.VisualStudio.VSHelp80.Help2 help2; // Obtain the Help2 object from SVsHelp service. help2 = (Microsoft.VisualStudio.VSHelp80.Help2) this.GetService(typeof(Microsoft.VisualStudio.VSHelp.SVsHelp));
See Also
Reference
Microsoft.VisualStudio.VSHelp80 Namespace
Other Resources
How to: Use a VSPackage Tool Window to Display a Help Topic
How to: Use an Add-in to Display Information About a Help Topic
How to: Use a Macro to Display Information About a Help Topic