Help2.Filter, propriété

Article
05/16/2015

Obtient ou définit le filtre de collection.

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

Syntaxe

'Déclaration
Property Filter As String

string Filter { get; set; }

property String^ Filter {
    String^ get ();
    void set (String^ value);
}

abstract Filter : string with get, set

function get Filter () : String 
function set Filter (value : String)

Valeur de propriété

Type : String
Retourne une chaîne contenant le nom du filtre.

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.

Notes

Assurez -vous de définir un filtre sur la collection d'aide de Visual Studio avant que vous exécutiez cet exemple.Sinon la méthode retournera une exception null.

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;
    HelpFilterExample(_applicationObject);
}

public void HelpFilterExample(DTE2 dte)
{
    // This add-in displays a message box with the filter applied to 
    // the active Help collection.
    // inIt then changes the filter
    // and displays the Contents window of Document 
    // Explorer with the new filter applied.
    try
    {
        Microsoft.VisualStudio.VSHelp80.Help2 help2 =
(Microsoft.VisualStudio.VSHelp80.Help2)_applicationObject.GetObject 
("Help2");

        // Display the name of the filter.
        MessageBox.Show("The Help filter name is: "
help2.Filter.ToString());
        // Set the filter to Visual C#.
        help2.Filter = "Visual C#";
        // Set the focus to the Contents window and
        // open Document Explorer.
        help2.Contents();
    }
    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