Help Interface

Reference

Definition

Namespace:: Microsoft.VisualStudio.VSHelp

Assembly:: Microsoft.VisualStudio.VSHelp.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Dual interface used to provide F1 Help from a modal or non-modal dialog box.

public interface class Help

public interface class Help

__interface Help

[System.Runtime.InteropServices.Guid("4A791148-19E4-11D3-B86B-00C04F79F802")]
[System.Runtime.InteropServices.TypeLibType(4160)]
public interface Help

[System.Runtime.InteropServices.Guid("4A791148-19E4-11D3-B86B-00C04F79F802")]
public interface Help

[<System.Runtime.InteropServices.Guid("4A791148-19E4-11D3-B86B-00C04F79F802")>]
[<System.Runtime.InteropServices.TypeLibType(4160)>]
type Help = interface

[<System.Runtime.InteropServices.Guid("4A791148-19E4-11D3-B86B-00C04F79F802")>]
type Help = interface

Public Interface Help

Derived: Microsoft.VisualStudio.VSHelp.DExploreAppObj

Microsoft.VisualStudio.VSHelp.DExploreAppObjClass

Microsoft.VisualStudio.VSHelp80.Help2

Attributes: GuidAttribute TypeLibTypeAttribute

Remarks

This interface is deprecated. See Help2 for information about the current implementation.

Notes to Callers

Call to add F1 Help to a modal or non-modal dialog box.

Properties

Collection	Returns the name of the current collection loaded.
Filter	Gets or sets the collection filter.
FilterQuery	Returns the filter query string for the current Help collection filter.
Help	Used for compatibility with DTE2, when used as `Windows.External`, `Help2` object returns itself.
HelpOwner	Gets or sets the help owner.
HxSession	Returns the `HxSession` object.

Methods

CanShowFilterUI()	Do not use.
CanSyncContents(String)	Determines if a URL can be synchronized to or not.
Close()	Closes the Microsoft Document Explorer window and all of its pages.
Contents()	Selects the Contents navigation window and opens it if it is closed.
DisplayTopicFrom_OLD_Help(String, UInt32)	Provides support for .chm and .hlp files.
DisplayTopicFromF1Keyword(String)	Provides F1 Help for a modal or non-modal dialog box.
DisplayTopicFromId(String, UInt32)	Finds and displays the first topic defined by the supplied F1 keyword and context help ID.
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)	Displays a help topic in Document Explorer and triggers a specified event after the topic has been loaded.
FilterUI()	Displays the user interface to create, edit, or delete filters.
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.
Index()	Selects the Index window.
IndexResults()	Selects the Index Results window.
Search()	Selects the Search dialog box.
SearchResults()	Selects the Search Results window.
SetCollection(String, String)	Loads a Help collection into Document Explorer.
SyncContents(String)	Synchronizes the table of contents to the supplied URL.
SyncIndex(String, Int32)	Looks up the topic specifies by the K-keyword but does not display the topic in Document Explorer, unless specified.

Applies to

Share via