Click to Rate and Give Feedback
MSDN
MSDN Library
Visual Studio 2005
Visual Studio
Visual Studio SDK
User Interfaces
Help
Help Integration
Help API Reference
Collapse All/Expand All Collapse All
This page is specific to
Microsoft Visual Studio 2005/.NET Framework 2.0

Other versions are also available for the following:
Visual Studio SDK
Help2 Interface

The interface that supports Document Explorer.

Namespace: Microsoft.VisualStudio.VSHelp80
Assembly: Microsoft.VisualStudio.VSHelp80 (in microsoft.visualstudio.vshelp80.dll)

Visual Basic (Declaration)
<GuidAttribute("78413D2D-0492-4A9B-AB25-730633679977")> _
Public Interface Help2
	Inherits Help
Visual Basic (Usage)
Dim instance As Help2
C#
[GuidAttribute("78413D2D-0492-4A9B-AB25-730633679977")] 
public interface Help2 : Help
C++
[GuidAttribute(L"78413D2D-0492-4A9B-AB25-730633679977")] 
public interface class Help2 : Help
J#
/** @attribute GuidAttribute("78413D2D-0492-4A9B-AB25-730633679977") */ 
public interface Help2 extends Help
JScript
GuidAttribute("78413D2D-0492-4A9B-AB25-730633679977") 
public interface Help2 extends Help

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:

    C#
    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:

    C#
    Microsoft.VisualStudio.VSHelp80.Help2 help2 = 
    (Microsoft.VisualStudio.VSHelp80.Help2)dte.<b>GetObject("Help2")</b>;

In a VSPackage:

  • You obtain the Help2 object through SVsHelp service:

    C#
    Microsoft.VisualStudio.VSHelp80.Help2 help2;
    // Obtain the Help2 object from SVsHelp service.
    help2 = 
    (Microsoft.VisualStudio.VSHelp80.Help2)
this.GetService(typeof(Microsoft.VisualStudio.VSHelp.SVsHelp));
Tags What's this?: Add a tag
Community Content   What is Community Content?
Add new content RSS  Annotations
Processing
© 2009 Microsoft Corporation. All rights reserved. Terms of Use | Trademarks | Privacy Statement | Site Feedback
Page view tracker