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)

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

NameDescription
System_CAPS_pubpropertyCollection

Returns the name of the current collection loaded.

System_CAPS_pubpropertyFilter

Gets or sets the collection filter.

System_CAPS_pubpropertyFilterQuery

Returns the filter query string for the current Help collection filter.

System_CAPS_pubpropertyHelp

Used for compatibility with DTE2, when used as Windows.External, Help2 object returns itself.

System_CAPS_pubpropertyHelpOwner

Gets or sets the help owner.

System_CAPS_pubpropertyHxSession

Returns the HxSession object.

NameDescription
System_CAPS_pubmethodCanShowFilterUI()

Do not use.

System_CAPS_pubmethodCanSyncContents(String)

Determines if a URL can be synchronized to or not.

System_CAPS_pubmethodClose()

Closes the Microsoft Document Explorer window and all of its pages.

System_CAPS_pubmethodContents()

Selects the Contents navigation window and opens it if it is closed.

System_CAPS_pubmethodDisplayTopicFrom_OLD_Help(String, UInt32)

Provides support for .chm and .hlp files.

System_CAPS_pubmethodDisplayTopicFromF1Keyword(String)

Provides F1 Help for a modal or non-modal dialog box.

System_CAPS_pubmethodDisplayTopicFromId(String, UInt32)

Finds and displays the first topic defined by the supplied F1 keyword and context help ID.

System_CAPS_pubmethodDisplayTopicFromKeyword(String)

Performs a lookup by using the K-keyword index.

System_CAPS_pubmethodDisplayTopicFromURL(String)

Displays a help topic specified by the URL in Document Explorer.

System_CAPS_pubmethodDisplayTopicFromURLEx(String, IVsHelpTopicShowEvents)

Displays a help topic in Document Explorer and triggers a specified event after the topic has been loaded.

System_CAPS_pubmethodFilterUI()

Displays the user interface to create, edit, or delete filters.

System_CAPS_pubmethodGetNextTopic(String)

Given a URL returns the next URL in the table of contents.

System_CAPS_pubmethodGetObject(String, String)

This API supports the product infrastructure and is not intended to be used directly from your code. Microsoft Internal Use Only.

System_CAPS_pubmethodGetPrevTopic(String)

Given a URL returns the previous URL in the table of contents.

System_CAPS_pubmethodIndex()

Selects the Index window.

System_CAPS_pubmethodIndexResults()

Selects the Index Results window.

System_CAPS_pubmethodSearch()

Selects the Search dialog box.

System_CAPS_pubmethodSearchResults()

Selects the Search Results window.

System_CAPS_pubmethodSetCollection(String, String)

Loads a Help collection into Document Explorer.

System_CAPS_pubmethodSyncContents(String)

Synchronizes the table of contents to the supplied URL.

System_CAPS_pubmethodSyncIndex(String, Int32)

Looks up the topic specifies by the K-keyword but does not display the topic in Document Explorer, unless specified.

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.

Return to top
Show: