Help2 - интерфейс

Статья
05/17/2015

Интерфейс, который поддерживает проводник документов.

Пространство имен: 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	Инфраструктура. Только для внутреннего использования в корпорации Майкрософт.
	Filter	Возвращает или задает фильтр коллекции.
	FilterQuery	Возвращает строку запроса для текущего фильтра коллекции Справки.
	Help	Используется для совместимости с DTE2при использовании как Windows.External" Help2 возвращает объект.
	HelpOwner	Инфраструктура. Только для внутреннего использования в корпорации Майкрософт.
	HxSession	Инфраструктура. Только для внутреннего использования в корпорации Майкрософт.

В начало страницы

Методы

	Имя	Описание
	AskAQuestion	Отображает URL-адрес на основе предоставленного флаге.
	CanShowFilterUI	Устаревший метод.
	CanSyncContents	Определяет, если URL-адрес можно синхронизировать или нет.
	Close	Закрывает проводник документов и все его страницы.
	Contents	Выбирает Содержание будет открыто окно навигации и его, если он закрыть.
	DisplayTopicFrom_OLD_Help	Устаревший метод.Взамен рекомендуется использовать DisplayTopicFromF1Keyword.
	DisplayTopicFromF1Keyword	Отображает справку F1 для диалоговых окон и обратно.
	DisplayTopicFromId	Устаревший.Взамен рекомендуется использовать DisplayTopicFromF1Keyword.
	DisplayTopicFromKeyword	Выполняет поиск с использованием индекса K-ключевого слова.
	DisplayTopicFromURL	Отображает раздел Справки, определенную url-адреса в проводнике windows.
	DisplayTopicFromURLEx	Инфраструктура. Только для внутреннего использования в корпорации Майкрософт.
	DisplayTopicFromURLEx2	Отображает раздел Справки в проводнике windows документов на основе флагах отображения справки.
	Favorites	Отображает окно инструментов " избранное ".
	FilterUI	Устаревший метод.
	GetNextTopic	Имея URL-адрес возвращает следующий URL-адрес в оглавлении.
	GetObject	Инфраструктура. Только для внутреннего использования в корпорации Майкрософт.
	GetPrevTopic	Имея URL-адрес возвращает предыдущее url-адреса в оглавлении.
	HowDoI	Отображает Инструкции окна.
	Index	Выбирает Индекс окна.
	IndexResults	Выбирает Результаты отбора по указателю окна.
	InitializeSettingsToken	Инфраструктура. Только для внутреннего использования в корпорации Майкрософт.
	Search	Выбирает Найти диалоговое окно.
	SearchEx	Выбирает Найти окно, и, при необходимости, заполняет Найти диалоговое окно с терминой или выполняет поиск конкретной термины.
	SearchResults	Выбирает Результаты поиска окна.
	SetCollection	Инфраструктура. Только для внутреннего использования в корпорации Майкрософт.
	SyncContents	Синхронизировать оглавление по указанному url-адресу.
	SyncIndex	Ищет указанную тему K-ключевым словом, но не будет отображаться тему в проводнике windows документов, если он указан.

В начало страницы

Заметки

Help2 поддерживает инструкции, поиск и избранное. Главная точка входа для доступа к проводник документов (Dexplorer.exe).

Например, вы получаете Help2 зависит от объекта приложение.

в non-VSPackages:

Help2 объект дочерний элемент DTE в иерархии объекта и может быть осуществляется с помощью поздно-привязанное DTE.Help свойство. Доступ 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.

Получено Help2 объект до конца SVsHelp служба:

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