DExploreAppObj Interface

Definition

Namespace:

Microsoft.VisualStudio.VSHelp

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Deprecated. Use Help2 instead.

public interface class DExploreAppObj : Microsoft::VisualStudio::VSHelp::Help, Microsoft::VisualStudio::VSHelp::IVsHelpEvents_Event

public interface class DExploreAppObj : Microsoft::VisualStudio::VSHelp::Help, Microsoft::VisualStudio::VSHelp::IVsHelpEvents_Event

__interface DExploreAppObj : Microsoft::VisualStudio::VSHelp::Help, Microsoft::VisualStudio::VSHelp::IVsHelpEvents_Event

[System.Runtime.InteropServices.CoClass(typeof(Microsoft.VisualStudio.VSHelp.DExploreAppObjClass))]
[System.Runtime.InteropServices.Guid("4A791148-19E4-11D3-B86B-00C04F79F802")]
[System.Runtime.InteropServices.ComVisible(false)]
public interface DExploreAppObj : Microsoft.VisualStudio.VSHelp.Help, Microsoft.VisualStudio.VSHelp.IVsHelpEvents_Event

[<System.Runtime.InteropServices.CoClass(typeof(Microsoft.VisualStudio.VSHelp.DExploreAppObjClass))>]
[<System.Runtime.InteropServices.Guid("4A791148-19E4-11D3-B86B-00C04F79F802")>]
[<System.Runtime.InteropServices.ComVisible(false)>]
type DExploreAppObj = interface
    interface Help
    interface IVsHelpEvents_Event

Public Interface DExploreAppObj
Implements Help, IVsHelpEvents_Event

Derived

Attributes

CoClassAttribute GuidAttribute ComVisibleAttribute

Implements

Help IVsHelpEvents_Event

Remarks

This class is deprecated.

Properties

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

Methods

add_OnCollectionChanged(IVsHelpEvents_OnCollectionChangedEventHandler)	(Inherited from IVsHelpEvents_Event)
add_OnFilterChanged(IVsHelpEvents_OnFilterChangedEventHandler)	(Inherited from IVsHelpEvents_Event)
CanShowFilterUI()	Do not use. (Inherited from Help)
CanSyncContents(String)	Determines if a URL can be synchronized to or not. (Inherited from Help)
Close()	Closes the Microsoft Document Explorer window and all of its pages. (Inherited from Help)
Contents()	Selects the Contents navigation window and opens it if it is closed. (Inherited from Help)
DisplayTopicFrom_OLD_Help(String, UInt32)	Provides support for .chm and .hlp files. (Inherited from Help)
DisplayTopicFromF1Keyword(String)	Provides F1 Help for a modal or non-modal dialog box. (Inherited from Help)
DisplayTopicFromId(String, UInt32)	Finds and displays the first topic defined by the supplied F1 keyword and context help ID. (Inherited from Help)
DisplayTopicFromKeyword(String)	Performs a lookup by using the K-keyword index. (Inherited from Help)
DisplayTopicFromURL(String)	Displays a help topic specified by the URL in Document Explorer. (Inherited from Help)
DisplayTopicFromURLEx(String, IVsHelpTopicShowEvents)	Displays a help topic in Document Explorer and triggers a specified event after the topic has been loaded. (Inherited from Help)
FilterUI()	Displays the user interface to create, edit, or delete filters. (Inherited from Help)
GetNextTopic(String)	Given a URL returns the next URL in the table of contents. (Inherited from Help)
GetObject(String, String)	Microsoft Internal Use Only. (Inherited from Help)
GetPrevTopic(String)	Given a URL returns the previous URL in the table of contents. (Inherited from Help)
Index()	Selects the Index window. (Inherited from Help)
IndexResults()	Selects the Index Results window. (Inherited from Help)
remove_OnCollectionChanged(IVsHelpEvents_OnCollectionChangedEventHandler)	(Inherited from IVsHelpEvents_Event)
remove_OnFilterChanged(IVsHelpEvents_OnFilterChangedEventHandler)	(Inherited from IVsHelpEvents_Event)
Search()	Selects the Search dialog box. (Inherited from Help)
SearchResults()	Selects the Search Results window. (Inherited from Help)
SetCollection(String, String)	Loads a Help collection into Document Explorer. (Inherited from Help)
SyncContents(String)	Synchronizes the table of contents to the supplied URL. (Inherited from Help)
SyncIndex(String, Int32)	Looks up the topic specifies by the K-keyword but does not display the topic in Document Explorer, unless specified. (Inherited from Help)

Events

OnCollectionChanged	Called when the Help collection changes. (Inherited from IVsHelpEvents_Event)
OnFilterChanged	Called when the filter applied to the Help collection changes. (Inherited from IVsHelpEvents_Event)