IVsHelpProvider Interface

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Shell.Interop
Assembly:
Microsoft.VisualStudio.Shell.Interop.10.0.dll
Assembly:
Microsoft.VisualStudio.Interop.dll

Implement this interface to override the default help experience.

public interface class IVsHelpProvider
public interface class IVsHelpProvider
__interface IVsHelpProvider
[System.Runtime.InteropServices.Guid("A0B29E84-6CFD-490D-9A17-B0BF64D58C55")]
[System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)]
public interface IVsHelpProvider
[<System.Runtime.InteropServices.Guid("A0B29E84-6CFD-490D-9A17-B0BF64D58C55")>]
[<System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)>]
type IVsHelpProvider = interface
Public Interface IVsHelpProvider
Attributes
GuidAttribute InterfaceTypeAttribute

Remarks

This is most appropriate for Isolated Shell applications which don't want Visual Studio help to appear.To register as a Help Provider, add the following registration with a pkgdef file:

[$RootKey$\HelpProviders]@="<HelpProviderServiceGUID>"  
 [$RootKey$\HelpProviders\<HelpProviderServiceGUID>]@="<Help Provider Name>"  
Name="<resourceID>"  
Package="<HelpProviderPackageGUID>"

The Name and Package values indicate the resource ID and VS Package for the Help Provider's localized name.Updating the HelpProviders key Default value to the new Help Provider Service GUID sets the new help provider as the default.Users may override the default help provider by setting a CurrentHelpProvider preference through <xref:Microsoft.VisualStudio.Shell.Interop.IVsSettingStore>:

[SettingsScope_UserSettings\Help]  
CurrentHelpProvider="<preferred Help Provider Service GUID>"

Methods

DisplayTopic(Array, Array)

Displays the help topic for the given context

Applies to