Help2 接口

2015-05-17

支持的接口文档资源管理器。

命名空间： Microsoft.VisualStudio.VSHelp80
程序集： Microsoft.VisualStudio.VSHelp80（在 Microsoft.VisualStudio.VSHelp80.dll 中）

语法

声明
<GuidAttribute("78413D2D-0492-4A9B-AB25-730633679977")> _
Public Interface Help2 _
    Inherits Help

[GuidAttribute("78413D2D-0492-4A9B-AB25-730633679977")]
public interface Help2 : Help

[GuidAttribute(L"78413D2D-0492-4A9B-AB25-730633679977")]
public interface class Help2 : Help

[<GuidAttribute("78413D2D-0492-4A9B-AB25-730633679977")>]
type Help2 =  
    interface 
        interface Help 
    end

public interface Help2 extends Help

Help2 类型公开以下成员。

属性

	名称	说明
	Collection	基础结构。仅由 Microsoft 内部使用。
	Filter	获取或设置集合筛选器。
	FilterQuery	返回当前帮助集合筛选器的查询字符串。
	Help	用于 DTE2的兼容性，那么，当用作 Windows.External， Help2 对象返回自身。
	HelpOwner	基础结构。仅由 Microsoft 内部使用。
	HxSession	基础结构。仅由 Microsoft 内部使用。

页首

方法

	名称	说明
	AskAQuestion	显示基于将所提供的标志的 URL。
	CanShowFilterUI	否决的方法。
	CanSyncContents	确定 URL 是否可以同步到。
	Close	关闭文档资源管理器及其所有页。
	Contents	，如果是封闭式的，选择内容导航窗口并打开它。
	DisplayTopicFrom_OLD_Help	否决的方法。请改用 DisplayTopicFromF1Keyword。
	DisplayTopicFromF1Keyword	显示帮助涉及 F1 并从对话框。
	DisplayTopicFromId	已否决。请改用 DisplayTopicFromF1Keyword。
	DisplayTopicFromKeyword	使用 K 关键字索引，执行查找。
	DisplayTopicFromURL	显示指定 URL 的帮助主题介绍资源管理器。
	DisplayTopicFromURLEx	基础结构。仅由 Microsoft 内部使用。
	DisplayTopicFromURLEx2	显示基于显示帮助标志的帮助主题介绍资源管理器。
	Favorites	显示收藏夹工具窗口。
	FilterUI	否决的方法。
	GetNextTopic	给定 URL 返回该目录下的 URL。
	GetObject	基础结构。仅由 Microsoft 内部使用。
	GetPrevTopic	给定 URL 返回该目录以前的 URL。
	HowDoI	显示如何我窗口。
	Index	选择索引窗口。
	IndexResults	选择索引结果窗口。
	InitializeSettingsToken	基础结构。仅由 Microsoft 内部使用。
	Search	选择搜索对话框。
	SearchEx	选择搜索窗口和选择性地使用术语加载搜索对话框或执行搜索特定的术语。
	SearchResults	选择搜索结果窗口。
	SetCollection	基础结构。仅由 Microsoft 内部使用。
	SyncContents	同步这些内容。所提供的 URL。
	SyncIndex	查找该 K 关键字指定的主题，但是，它不显示主题介绍资源管理器中，除非特别说明。

页首

备注

Help2 支持如何实现、搜索和收藏夹。它是主入口点访问文档资源管理器 (Dexplorer.exe)。

如何获取 Help2 对象取决于应用程序。

在非 vspackage:

使用后 DTE.Help 属性， Help2 对象是 DTE 的子级在其对象层次结构的，可以访问。对于不是外接程序或宏的应用程序的访问 Help2 ，您必须获取 DTE实例，由以下示例演示的:
```
EnvDTE.DTE dte;
dte = (EnvDTE.DTE)System.Runtime.InteropServices.Marshal.GetActiveObject("VisualStudio.DTE.8.0");
Object helpobj  = dte.Help;
```

在外接程序可以直接获取 Help2 对象:

Microsoft.VisualStudio.VSHelp80.Help2 help2 = 
(Microsoft.VisualStudio.VSHelp80.Help2)dte.GetObject("Help2");

在 VSPackage:

通过 SVsHelp 服务获取 Help2 对象:

Microsoft.VisualStudio.VSHelp80.Help2 help2;
// Obtain the Help2 object from SVsHelp service.
help2 = 
(Microsoft.VisualStudio.VSHelp80.Help2)
this.GetService(typeof(Microsoft.VisualStudio.VSHelp.SVsHelp));

请参阅

参考

Microsoft.VisualStudio.VSHelp80 命名空间

其他资源

How to: Use a VSPackage Tool Window to Display a Help Topic

How to: Use an Add-in to Display Information About a Help Topic

How to: Use a Macro to Display Information About a Help Topic