IVsHelpProvider Interface
Implement this interface to override the default help experience.
Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop.10.0 (in Microsoft.VisualStudio.Shell.Interop.10.0.dll)
Syntax
'Declaration
<GuidAttribute("A0B29E84-6CFD-490D-9A17-B0BF64D58C55")> _
<InterfaceTypeAttribute(ComInterfaceType.InterfaceIsIUnknown)> _
Public Interface IVsHelpProvider
[GuidAttribute("A0B29E84-6CFD-490D-9A17-B0BF64D58C55")]
[InterfaceTypeAttribute(ComInterfaceType.InterfaceIsIUnknown)]
public interface IVsHelpProvider
[GuidAttribute(L"A0B29E84-6CFD-490D-9A17-B0BF64D58C55")]
[InterfaceTypeAttribute(ComInterfaceType::InterfaceIsIUnknown)]
public interface class IVsHelpProvider
[<GuidAttribute("A0B29E84-6CFD-490D-9A17-B0BF64D58C55")>]
[<InterfaceTypeAttribute(ComInterfaceType.InterfaceIsIUnknown)>]
type IVsHelpProvider = interface end
public interface IVsHelpProvider
The IVsHelpProvider type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
DisplayTopic | Displays the help topic for the given context |
Top
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 IVsSettingStore:
[SettingsScope_UserSettings\Help]
CurrentHelpProvider="<preferred Help Provider Service GUID>"