Help2.DisplayTopicFromKeyword, méthode

Article
05/16/2015

Effectue une recherche à l'aide de l'index des mots clés K.

Espace de noms : Microsoft.VisualStudio.VSHelp80
Assembly : Microsoft.VisualStudio.VSHelp80 (dans Microsoft.VisualStudio.VSHelp80.dll)

Syntaxe

'Déclaration
Sub DisplayTopicFromKeyword ( _
    pszKeyword As String _
)

void DisplayTopicFromKeyword(
    string pszKeyword
)

void DisplayTopicFromKeyword(
    [InAttribute] String^ pszKeyword
)

abstract DisplayTopicFromKeyword : 
        pszKeyword:string -> unit

function DisplayTopicFromKeyword(
    pszKeyword : String
)

Paramètres

pszKeyword
Type : String

Index des mots clés K de la rubrique d'aide à la rechercher et s'afficher.

Notes

Uniquement si une correspondance est recherchée alors Explorateur de documents affiche le sujet.

Exemples

Créez une macro complémentaire de Visual Studio à l'aide de Visual C# comme décrit dans Comment : créer un complément. Ajoutez les références à Microsoft.VisualStudio.VSHelp, à Microsoft.VisualStudio.VSHelp80, et à System.Windows.Forms. Remplacez code dans la méthode d'OnConnection dans le fichier Connect.cs par code suivant. Exécutez l'exemple de code comme décrit dans Comment : compiler et exécuter les exemples de code du modèle objet 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);
    }
}

Sécurité .NET Framework

Confiance totale accordée à l'appelant immédiat. Ce membre ne peut pas être utilisé par du code d'un niveau de confiance partiel. Pour plus d'informations, voir Utilisation de bibliothèques à partir de code d'un niveau de confiance partiel.

Voir aussi

Référence

Help2 Interface

Microsoft.VisualStudio.VSHelp80, espace de noms

Partager via