Help2 Interface

 

The interface that supports Document Explorer.

Namespace:   Microsoft.VisualStudio.VSHelp80
Assembly:  Microsoft.VisualStudio.VSHelp80 (in Microsoft.VisualStudio.VSHelp80.dll)

[GuidAttribute("78413D2D-0492-4A9B-AB25-730633679977")]
public interface Help2 : Help

NameDescription
System_CAPS_pubpropertyCollection

This API supports the product infrastructure and is not intended to be used directly from your code. Microsoft Internal Use Only.

System_CAPS_pubpropertyFilter

Gets or sets the collection filter.

System_CAPS_pubpropertyFilterQuery

Returns the query string for the current Help collection filter.

System_CAPS_pubpropertyHelp

Used for compatibility with DTE2, when used as Windows.External, Help2 object returns itself.

System_CAPS_pubpropertyHelpOwner

This API supports the product infrastructure and is not intended to be used directly from your code. Microsoft Internal Use Only.

System_CAPS_pubpropertyHxSession

This API supports the product infrastructure and is not intended to be used directly from your code. Microsoft Internal Use Only.

NameDescription
System_CAPS_pubmethodAskAQuestion(UInt32)

Displays a URL based on the supplied flag.

System_CAPS_pubmethodCanShowFilterUI()

Deprecated method.

System_CAPS_pubmethodCanSyncContents(String)

Determines if a URL can be synchronized to or not.

System_CAPS_pubmethodClose()

Closes Document Explorer and all of its pages.

System_CAPS_pubmethodContents()

Selects the Contents navigation window and opens it if it is closed.

System_CAPS_pubmethodDisplayTopicFrom_OLD_Help(String, UInt32)

Deprecated method. Use DisplayTopicFromF1Keyword instead.

System_CAPS_pubmethodDisplayTopicFromF1Keyword(String)

Displays Help for F1 and from dialog boxes.

System_CAPS_pubmethodDisplayTopicFromId(String, UInt32)

Deprecated. Use DisplayTopicFromF1Keyword instead.

System_CAPS_pubmethodDisplayTopicFromKeyword(String)

Performs a lookup by using the K-keyword index.

System_CAPS_pubmethodDisplayTopicFromURL(String)

Displays a Help topic specified by the URL in Document Explorer.

System_CAPS_pubmethodDisplayTopicFromURLEx(String, IVsHelpTopicShowEvents)

This API supports the product infrastructure and is not intended to be used directly from your code. Microsoft Internal Use Only.

System_CAPS_pubmethodDisplayTopicFromURLEx2(String, UInt32, String)

Displays a Help topic in Document Explorer that is based on help display flags.

System_CAPS_pubmethodFavorites()

Displays the Favorites tool window.

System_CAPS_pubmethodFilterUI()

Deprecated method.

System_CAPS_pubmethodGetNextTopic(String)

Given a URL returns the next URL in the table of contents.

System_CAPS_pubmethodGetObject(String, String)

This API supports the product infrastructure and is not intended to be used directly from your code. Microsoft Internal Use Only.

System_CAPS_pubmethodGetPrevTopic(String)

Given a URL returns the previous URL in the table of contents.

System_CAPS_pubmethodHowDoI()

Shows the How Do I window.

System_CAPS_pubmethodIndex()

Selects the Index window.

System_CAPS_pubmethodIndexResults()

Selects the Index Results window.

System_CAPS_pubmethodInitializeSettingsToken(String)

This API supports the product infrastructure and is not intended to be used directly from your code. For Microsoft Internal Use Only.

System_CAPS_pubmethodSearch()

Selects the Search dialog box.

System_CAPS_pubmethodSearchEx(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.

System_CAPS_pubmethodSearchResults()

Selects the Search Results window.

System_CAPS_pubmethodSetCollection(String, String)

This API supports the product infrastructure and is not intended to be used directly from your code. Microsoft Internal Use Only.

System_CAPS_pubmethodSyncContents(String)

Synchronizes the table of contents to the supplied URL.

System_CAPS_pubmethodSyncIndex(String, Int32)

Looks up the topic specified by the K-keyword, but it does not display the topic in Document Explorer, unless specified.

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));
    
Return to top
Show: