Help2.DisplayTopicFromKeyword(String) Метод

Определение

Выполняет уточняющий запрос с помощью индекса ключевого слова К.Performs a lookup by using the K-keyword index.

public:
 void DisplayTopicFromKeyword(System::String ^ pszKeyword);
public:
 void DisplayTopicFromKeyword(Platform::String ^ pszKeyword);
void DisplayTopicFromKeyword(std::wstring const & pszKeyword);
[System.Runtime.InteropServices.DispId(9)]
public void DisplayTopicFromKeyword (string pszKeyword);
[<System.Runtime.InteropServices.DispId(9)>]
abstract member DisplayTopicFromKeyword : string -> unit
Public Sub DisplayTopicFromKeyword (pszKeyword As String)

Параметры

pszKeyword
String

Индекс ключевого слова K раздела справки, который требуется найти и отобразить.K-keyword index of the Help topic to find and display.

Реализации

Атрибуты

Примеры

Создайте Visual StudioVisual Studio надстройку, используя Visual C#Visual C# , как описано в разделе инструкции. Создание надстройки.Create a Visual StudioVisual Studio add-in by using Visual C#Visual C# as described in How to: Create an Add-In. Добавьте ссылки на Microsoft.VisualStudio.VSHelp , Microsoft.VisualStudio.VSHelp80 и System.Windows.Forms .Add references to Microsoft.VisualStudio.VSHelp, Microsoft.VisualStudio.VSHelp80, and System.Windows.Forms. Замените код в OnConnection методе в файле Connect.cs следующим кодом.Replace the code in the OnConnection method in the Connect.cs file with the following code. Запустите пример кода, как описано в разделе как скомпилировать и запустить примеры кода объектной модели автоматизации.Run the code example as described in How to: Compile and Run the Automation Object Model Code Examples.

using System;  
using Extensibility;  
using EnvDTE;  
using EnvDTE80;  
using Microsoft.VisualStudio.VSHelp;  
using Microsoft.VisualStudio.VSHelp80;  
using System.Windows.Forms;  

public void OnConnection(object application,  
ext_ConnectMode connectMode, object addInInst, ref Array custom)  
{  
    _applicationObject = (DTE2)application;  
    _addInInstance = (AddIn)addInInst;  
    HelpDisplayFromKeywordExample(_applicationObject);  
}  

public void HelpDisplayFromKeywordExample(DTE2 dte)  
{  
    // This opens Document Explorer and   
    // displays the topic specified  
    // by the K keyword.  
    try  
    {  
        Microsoft.VisualStudio.VSHelp80.Help2 help2 =  
(Microsoft.VisualStudio.VSHelp80.Help2)_applicationObject.GetObject ("Help2");  

        // Display the Arrays topic.  
        help2.DisplayTopicFromKeyword("arrays");  
    }  

    catch (SystemException ex)  
    {  
        MessageBox.Show("ERROR: " + ex);  
    }  
}  

Комментарии

Если найдено только одно совпадение, в обозревателе документов отображается раздел.If only one match is found then Document Explorer displays the topic.

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