Help2 Интерфейс

Определение

Интерфейс, поддерживающий обозреватель документов.

public interface class Help2 : Microsoft::VisualStudio::VSHelp::Help
public interface class Help2 : Microsoft::VisualStudio::VSHelp::Help
__interface Help2 : Microsoft::VisualStudio::VSHelp::Help
[System.Runtime.InteropServices.Guid("78413D2D-0492-4A9B-AB25-730633679977")]
[System.Runtime.InteropServices.TypeLibType(4160)]
public interface Help2 : Microsoft.VisualStudio.VSHelp.Help
[<System.Runtime.InteropServices.Guid("78413D2D-0492-4A9B-AB25-730633679977")>]
[<System.Runtime.InteropServices.TypeLibType(4160)>]
type Help2 = interface
    interface Help
Public Interface Help2
Implements Help
Атрибуты
Реализации

Комментарии

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

Получение Help2 объекта зависит от приложения.

В не-VSPackage:

  • 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));  
    

Свойства

Collection

Только для внутреннего применения корпорацией Майкрософт.

Filter

Получает или задает фильтр коллекции.

FilterQuery

Возвращает строку запроса для текущего фильтра коллекции Справки.

Help

Используется для совместимости с DTE2 , когда используется как Windows. external, объект Help2 возвращает сам себя.

HelpOwner

Только для внутреннего применения корпорацией Майкрософт.

HxSession

Только для внутреннего применения корпорацией Майкрософт.

Методы

AskAQuestion(UInt32)

Отображает URL-адрес на основе предоставленного флага.

CanShowFilterUI()

Устаревший метод.

CanSyncContents(String)

Определяет, возможна ли синхронизация URL-адреса.

Close()

Закрывает проводник документов и все его страницы.

Contents()

Выбирает окно навигации по содержимому и открывает его, если оно закрыто.

DisplayTopicFrom_OLD_Help(String, UInt32)

Устаревший метод. Используйте вместо этого DisplayTopicFromF1Keyword(String).

DisplayTopicFromF1Keyword(String)

Отображает справку для F1 и из диалоговых окон.

DisplayTopicFromId(String, UInt32)

Не рекомендуется. Используйте вместо этого DisplayTopicFromF1Keyword(String).

DisplayTopicFromKeyword(String)

Выполняет уточняющий запрос с помощью индекса ключевого слова К.

DisplayTopicFromURL(String)

Отображает раздел справки, заданный URL-адресом в проводнике документов.

DisplayTopicFromURLEx(String, IVsHelpTopicShowEvents)

Только для внутреннего применения корпорацией Майкрософт.

DisplayTopicFromURLEx2(String, UInt32, String)

Отображает раздел справки в проводнике документов на основе флагов отображения справки.

Favorites()

Отображает окно инструментов "Избранное".

FilterUI()

Устаревший метод.

GetNextTopic(String)

Данный URL-адрес возвращает следующий URL-адрес в содержании.

GetObject(String, String)

Только для внутреннего применения корпорацией Майкрософт.

GetPrevTopic(String)

Данный URL-адрес возвращает предыдущий URL-адрес в содержании.

HowDoI()

Отображает окно инструкции .

Index()

Выбирает окно индекса .

IndexResults()

Выбирает окно « результаты индекса ».

InitializeSettingsToken(String)

Только для внутреннего использования в корпорации Майкрософт.

Search()

Выбирает диалоговое окно Поиск .

SearchEx(String, String, UInt32)

Выбирает окно поиска и при необходимости заполняет диалоговое окно поиска термином или выполняет поиск определенного термина.

SearchResults()

Выбирает окно Результаты поиска .

SetCollection(String, String)

Только для внутреннего применения корпорацией Майкрософт.

SyncContents(String)

Синхронизирует оглавление с указанным url-адресу.

SyncIndex(String, Int32)

Ищет раздел, указанный ключевым словом K, но не отображает раздел в обозревателе документов, если не указано иное.

Применяется к