Help 接口

  • 参考

定义

命名空间:
Microsoft.VisualStudio.VSHelp
程序集:
Microsoft.VisualStudio.VSHelp.dll
程序集:

双重接口，用于从模式或非模式对话框提供 F1 帮助。

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")>]
[<System.Runtime.InteropServices.TypeLibType(4160)>]
type Help = interface
Public Interface Help
派生
属性
GuidAttribute TypeLibTypeAttribute

注解

此接口已弃用。 有关 Help2 当前实现的信息，请参阅。

调用方说明

调用向模式或非模式对话框添加 F1 帮助。

属性

Collection

返回所加载的当前集合的名称。
Filter

获取或设置集合筛选器。
FilterQuery

返回当前帮助集合筛选器的筛选器查询字符串。
Help

用于与的兼容 DTE2 ，当用作Help2对象时，它将返回自身。
HelpOwner

获取或设置帮助所有者。
HxSession

返回 HxSession 对象。

方法

CanShowFilterUI()

请勿使用。
CanSyncContents(String)

确定是否可同步 URL。
Close()

关闭 Microsoft 文档资源管理器窗口及其所有页面。
Contents()

选择 " 内容 " 导航窗口并在关闭时将其打开。
DisplayTopicFrom_OLD_Help(String, UInt32)

为 .chm 和 .hlp 文件提供支持。
DisplayTopicFromF1Keyword(String)

为模式或非模式对话框提供 F1 帮助。
DisplayTopicFromId(String, UInt32)

查找并显示由提供的 F1 关键字和上下文帮助 ID 定义的第一个主题。
DisplayTopicFromKeyword(String)

使用 K 关键字索引执行查找。
DisplayTopicFromURL(String)

显示文档资源管理器中的 URL 指定的帮助主题。
DisplayTopicFromURLEx(String, IVsHelpTopicShowEvents)

显示文档资源管理器中的帮助主题，并在加载主题后触发指定的事件。
FilterUI()

显示用于创建、编辑或删除筛选器的用户界面。
GetNextTopic(String)

给定一个 URL，将返回目录中的下一个 URL。
GetObject(String, String)

仅限 Microsoft 内部使用。
GetPrevTopic(String)

给定一个 URL，将返回目录中的上一个 URL。
Index()

选择 " 索引 " 窗口。
IndexResults()

选择 " 索引结果 " 窗口。
Search()

选择 " 搜索 " 对话框。
SearchResults()

选择 " 搜索结果 " 窗口。
SetCollection(String, String)

将帮助集加载到文档资源管理器中。
SyncContents(String)

将目录同步到提供的 URL。
SyncIndex(String, Int32)

在主题中查找 K 关键字，但除非指定，否则不会在文档资源管理器中显示主题。

适用于