Método Help2.DisplayTopicFromKeyword

Artigo
05/17/2015

Executa uma pesquisa usando o índice de palavra-chave K.

Namespace: Microsoft.VisualStudio.VSHelp80
Assembly: Microsoft.VisualStudio.VSHelp80 (em Microsoft.VisualStudio.VSHelp80.dll)

Sintaxe

'Declaração
Sub DisplayTopicFromKeyword ( _
    pszKeyword As String _
)

void DisplayTopicFromKeyword(
    string pszKeyword
)

void DisplayTopicFromKeyword(
    [InAttribute] String^ pszKeyword
)

abstract DisplayTopicFromKeyword : 
        pszKeyword:string -> unit

function DisplayTopicFromKeyword(
    pszKeyword : String
)

Parâmetros

pszKeyword
Tipo: String

Índice de palavra-chave k do tópico da Ajuda para localizar e exibir.

Comentários

Se apenas uma correspondência for encontrada Document Explorer exibe o tópico.

Exemplos

Criar um Visual Studio suplemento usando Visual C# conforme descrito em Como criar um suplemento. Add references to Microsoft.VisualStudio.VSHelp, Microsoft.VisualStudio.VSHelp80, and System.Windows.Forms. Substitua o código na OnConnection método no arquivo Connect. cs com o código a seguir. Executar o exemplo de código, conforme descrito em Como compilar e executar os exemplos de código do modelo de objeto Automation.

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

Segurança do .NET Framework

Confiança total para o chamador imediato. O membro não pode ser usado por código parcialmente confiável. Para obter mais informações, consulte Usando bibliotecas de código parcialmente confiável.

Consulte também

Referência

Help2 Interface

Namespace Microsoft.VisualStudio.VSHelp80

Partilhar via