Collections de propriétés DTE

Les propriétés de niveau environnement sont organisées en catégories qui correspondent à la hiérarchie affichée dans la boîte de dialogue Options. Par exemple, DTE.Properties("TextEditor", "Basic") représente les paramètres présents dans le nœud Basic sous le nœud Éditeur de texte dans la boîte de dialogue Options. La plupart des paramètres des pages de la boîte de dialogue sont également représentés par des propriétés. Par exemple, une définition dans la page Tabulations du nœud Base sous le nœud Éditeur de texte est Taille des tabulations. Ce paramètre est représenté par les propriétés TabSize et TabSize. Chaque élément de propriété dispose d'une ou plusieurs valeurs, représentées par la propriété Value. Pour plus d'informations sur la modification de valeurs au moyen de propriétés, consultez Contrôle des paramètres de la boîte de dialogue Options.

Les documents suivants listent les catégories prédéfinies des paramètres qui sont inclus dans Visual Studio.

• Page Options, Environnement, propriétés de nœud

• Page Options, Polices et couleurs, propriétés de nœud

• Page Options, Éditeur de texte, propriétés de nœud

• Mise en forme, C#, Éditeur de texte, boîte de dialogue Options

Pour ajouter des paramètres à une page Options existante ou ajouter une page personnalisée à la boîte de dialogue Options, utilisez Kit de développement logiciel (SDK) Visual Studio. Pour plus d'informations, consultez le site Web Portail de partenaire écosystème des outils de développement.

Notes

Certaines pages de la boîte de dialogue Options ne prennent pas en charge l'automation. Pour plus d'informations sur les pages de propriétés qui prennent en charge l'automatisation, consultez Détermination des noms d'éléments de propriété dans les pages Options.

Pour ouvrir la boîte de dialogue Options dans l'environnement de développement intégré (IDE), dans le menu Outils, cliquez sur Options.

Exemple

L'exemple suivant illustre comment afficher les éléments de propriété accessibles sur la page Général dans le nœud C# sous le nœud Éditeur de texte dans la boîte de dialogue Options. Remarquez que dans le code, le nœud « C# » doit être représenté sous la forme « CSharp ». Pour plus d'informations sur l'exécution de l'exemple du complément, consultez Comment : compiler et exécuter les exemples de code du modèle objet Automation.

' Add-in code.
Public Sub OnConnection(ByVal application As Object, ByVal connectMode _
As Extensibility.ext_ConnectMode, ByVal addInInst As Object, ByRef _
custom As System.Array) Implements Extensibility.IDTExtensibility2.OnConnection

    applicationObject = CType(application, EnvDTE.DTE)
    addInInstance = CType(addInInst, EnvDTE.AddIn)
    ' Pass the applicationObject member variable to the code example.
    PropertiesExample (applicationObject)
    End Sub

Sub PropertiesExample(ByVal dte As DTE)
    ' Create and initialize a variable to represent the C# 
    ' text editor options page.
    Dim txtEdCS As EnvDTE.Properties = _
    DTE.Properties("TextEditor", "CSharp")
    Dim prop As EnvDTE.Property
    Dim msg As String

    ' Loop through each item in the C# text editor options page. 
    For Each prop In txtEdCS
        msg += ("PROP NAME: " & prop.Name & "   VALUE: " & _
        prop.Value) & vbCr
    Next
    MsgBox(msg)
End Sub

// Add-in code.
Using System.Windows.Forms;
public void OnConnection(object application,
 Extensibility.ext_ConnectMode connectMode, object addInInst,
 ref System.Array custom)
{
    applicationObject = (_DTE)application;
    addInInstance = (AddIn)addInInst;
    // Pass the applicationObject member variable to the code example.
    PropertiesExample((DTE)applicationObject); 
}

public void PropertiesExample( DTE dte ) 
{ 
    // Create and initialize a variable to represent the C# 
    // text editor options page.
    EnvDTE.Properties txtEdCS =
 dte.get_Properties( "TextEditor", "CSharp" ); 
    EnvDTE.Property prop = null; 
    string msg = null; 

    // Loop through each item in the C# text editor options page. 
    foreach ( EnvDTE.Property temp in txtEdCS ) 
    { 
        prop = temp; 
        msg += ( "PROP NAME: " + prop.Name + "   VALUE: " 
+ prop.Value ) + "\n"; 
    }
    MessageBox.Show( msg); 
}

Dans l'exemple suivant, qui contient une légère modification à l'exemple précédent, vous pouvez afficher les paramètres d'un nœud imbriqué ; dans ce cas, le nœud Mise en forme dans le nœud C# sous le nœud Éditeur de texte. Pour apporter la modification, remplacez la valeur du deuxième paramètre Properties par le paramètre que vous souhaitez afficher ou modifier, par exemple, DTE.Properties("TextEditor", "Basic-Specific") ou DTE.Properties("Environment", "ProjectsAndSolution"). Les valeurs à utiliser sont répertoriées au début de ce document.

Ce cas utilise « CSharp - Mise en forme »" pour afficher les paramètres d'options Mise en forme pour l'Éditeur de texte C#.

' Add-in code.
Sub PropertiesExample()
    ' Create and initialize a variable to represent the C# 
    ' Formatting text editor options page.
    Dim txtEdCSFormat As EnvDTE.Properties = _
    DTE.Properties("TextEditor", "CSharp-Specific")
    Dim prop As EnvDTE.Property
    Dim msg As String

    ' Loop through each item in the C# Formatting Options page. 
    For Each prop In txtEdCSFormat
        msg += ("PROP NAME: " & prop.Name & "   VALUE: " & _
        prop.Value) & vbCr
    Next
    MsgBox(msg)
End Sub

Voir aussi

Tâches

Comment : créer des pages d'options personnalisées

Concepts

Contrôle des paramètres de la boîte de dialogue Options

Détermination des noms d'éléments de propriété dans les pages Options