Help2.FilterQuery, propriété

Article
05/16/2015

Retourne la chaîne de requête pour le filtre d'aide actuel de collection.

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

Syntaxe

'Déclaration
ReadOnly Property FilterQuery As String

string FilterQuery { get; }

property String^ FilterQuery {
    String^ get ();
}

abstract FilterQuery : string with get

function get FilterQuery () : String

Valeur de propriété

Type : String
Une chaîne contenant la chaîne de requête pour le filtre actuel.

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;
    HelpFilterQueryExample(_applicationObject);
}
public void HelpFilterQueryExample(DTE2 dte)
{
    // This add-in displays a message box with the query string
    // for the active Help collection.
    try
    {
        Microsoft.VisualStudio.VSHelp80.Help2 help2 = 
(Microsoft.VisualStudio.VSHelp80.Help2)_applicationObject.GetObject 
("Help2");

        // Display the filter query.
        MessageBox.Show("The Help filter query is: " 
+ help2.FilterQuery.ToString());
    }
    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