Help2 Interface

Definition

Namespace:

Microsoft.VisualStudio.VSHelp80

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

The interface that supports Document Explorer.

public interface class Help2 : Microsoft::VisualStudio::VSHelp::Help

public interface class Help2 : Microsoft::VisualStudio::VSHelp::Help

__interface Help2 : Microsoft::VisualStudio::VSHelp::Help

[System.Runtime.InteropServices.Guid("78413D2D-0492-4A9B-AB25-730633679977")]
public interface Help2 : Microsoft.VisualStudio.VSHelp.Help

[<System.Runtime.InteropServices.Guid("78413D2D-0492-4A9B-AB25-730633679977")>]
type Help2 = interface
    interface Help

Public Interface Help2
Implements Help

Attributes

GuidAttribute

Implements

Help

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));  
  

Properties

Collection	Microsoft Internal Use Only.
Filter	Gets or sets the collection filter.
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.
HelpOwner	Microsoft Internal Use Only.
HxSession	Microsoft Internal Use Only.

Methods

AskAQuestion(UInt32)	Displays a URL based on the supplied flag.
CanShowFilterUI()	Deprecated method.
CanSyncContents(String)	Determines if a URL can be synchronized to or not.
Close()	Closes Document Explorer and all of its pages.
Contents()	Selects the Contents navigation window and opens it if it is closed.
DisplayTopicFrom_OLD_Help(String, UInt32)	Deprecated method. Use DisplayTopicFromF1Keyword(String) instead.
DisplayTopicFromF1Keyword(String)	Displays Help for F1 and from dialog boxes.
DisplayTopicFromId(String, UInt32)	Deprecated. Use DisplayTopicFromF1Keyword(String) instead.
DisplayTopicFromKeyword(String)	Performs a lookup by using the K-keyword index.
DisplayTopicFromURL(String)	Displays a Help topic specified by the URL in Document Explorer.
DisplayTopicFromURLEx(String, IVsHelpTopicShowEvents)	Microsoft Internal Use Only.
DisplayTopicFromURLEx2(String, UInt32, String)	Displays a Help topic in Document Explorer that is based on help display flags.
Favorites()	Displays the Favorites tool window.
FilterUI()	Deprecated method.
GetNextTopic(String)	Given a URL returns the next URL in the table of contents.
GetObject(String, String)	Microsoft Internal Use Only.
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.
IndexResults()	Selects the Index Results window.
InitializeSettingsToken(String)	For Microsoft Internal Use Only.
Search()	Selects the Search dialog box.
SearchEx(String, String, UInt32)	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.
SetCollection(String, String)	Microsoft Internal Use Only.
SyncContents(String)	Synchronizes the table of contents to the supplied URL.
SyncIndex(String, Int32)	Looks up the topic specified by the K-keyword, but it does not display the topic in Document Explorer, unless specified.