Help Interface

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

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

Syntax

'Declaration
<GuidAttribute("4A791148-19E4-11D3-B86B-00C04F79F802")> _
Public Interface Help

[GuidAttribute("4A791148-19E4-11D3-B86B-00C04F79F802")]
public interface Help

[GuidAttribute(L"4A791148-19E4-11D3-B86B-00C04F79F802")]
public interface class Help

[<GuidAttribute("4A791148-19E4-11D3-B86B-00C04F79F802")>]
type Help =  interface end

public interface Help

The Help type exposes the following members.

Properties

	Name	Description
	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.

Top

Methods

	Name	Description
	CanShowFilterUI	Do not use.
	CanSyncContents	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	Provides support for .chm and .hlp files.
	DisplayTopicFromF1Keyword	Provides F1 Help for a modal or non-modal dialog box.
	DisplayTopicFromId	Finds and displays the first topic defined by the supplied F1 keyword and context help ID.
	DisplayTopicFromKeyword	Performs a lookup by using the K-keyword index.
	DisplayTopicFromURL	Displays a help topic specified by the URL in Document Explorer.
	DisplayTopicFromURLEx	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	Given a URL returns the next URL in the table of contents.
	GetObject	Infrastructure. Microsoft Internal Use Only.
	GetPrevTopic	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	Loads a Help collection into Document Explorer.
	SyncContents	Synchronizes the table of contents to the supplied URL.
	SyncIndex	Looks up the topic specifies by the K-keyword but does not display the topic in Document Explorer, unless specified.

Top

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.

See Also

Reference

Microsoft.VisualStudio.VSHelp Namespace