Comment : créer un nouvel extrait de code avec remplacements

Article
08/10/2011

Vous pouvez souhaiter remplacer des portions d'extraits de code par la personne qui les insère. Cela est utile si vous souhaitez référencer une variable ou un objet spécifique, et souhaitez que l'utilisateur soit capable de remplacer la variable ou l'objet par une variable ou un objet de son projet. Les extraits de code IntelliSense donnent cette possibilité avec les éléments Literal et Object.

Lorsqu'un extrait de code est inséré, vous pouvez accéder à tous les objets de remplacement possibles dans votre code en cliquant sur l'objet de remplacement et en appuyant sur CTRL+Espace.

Création d'un remplacement littéral

L'élément Literal est utilisé pour identifier le remplacement d'une partie de code entièrement contenue dans l'extrait de code, mais qui sera probablement personnalisée après avoir été insérée dans le code. Par exemple, les chaînes littérales, les valeurs numériques et certains noms de variables doivent être déclarés comme littéral.

Cette procédure suppose que vous avez suivi les procédures expliquées dans la rubrique Comment : créer un extrait de code simple.

Pour créer un remplacement littéral

Localisez l'élément Snippet de l'extrait de code.
Ajoutez un élément Declarations en tant qu'enfant de l'élément Snippet. L'élément Declarations est utilisé pour grouper les déclarations de remplacement.
Ajoutez un élément Literal en tant qu'enfant de l'élément Declarations. L'élément Literal spécifie un littéral individuel. Un extrait de code peut avoir plusieurs remplacements littéraux.
Ajoutez un élément ID en tant qu'enfant de l'élément Literal. La valeur textuelle de cet élément spécifie le nom que vous utiliserez pour référencer le littéral dans l'élément Code.
Ajoutez un élément Default en tant qu'enfant de l'élément Literal. La valeur textuelle de l'élément Default spécifie la valeur par défaut du littéral lorsque vous insérez l'extrait de code.
Éventuellement, ajoutez les éléments Fonction et/ou Info-bulle.

Création d'un remplacement d'objet

L'élément Object est utilisé pour identifier un élément qui est requis par l'extrait de code, mais qui est vraisemblablement en dehors de l'extrait de code lui-même. Par exemple, les contrôles Windows Forms, les contrôles ASP.NET, les instances d'objet et les instances de type doivent être déclarées comme objets. Les déclarations d'objet requièrent qu'un type soit spécifié.

Cette procédure suppose que vous avez suivi les procédures expliquées dans la rubrique Comment : créer un extrait de code simple.

Pour créer un remplacement d'objet

Localisez l'élément Snippet de l'extrait de code.
Ajoutez un élément Declarations en tant qu'enfant de l'élément Snippet. L'élément Declarations est utilisé pour grouper les déclarations de remplacement.
Ajoutez un élément Object en tant qu'enfant de l'élément Declarations. L'élément Object spécifie un objet individuel. Un extrait de code peut avoir plusieurs remplacements d'objet.
Ajoutez un élément ID en tant qu'enfant de l'élément Object. La valeur textuelle de cet élément spécifie le nom que vous utiliserez pour référencer l'objet dans l'élément Code.
Ajoutez un élément Type comme un enfant de l'élément Object. La valeur textuelle de l'élément Default spécifie le type de l'objet.
Ajoutez un élément Default en tant qu'enfant de l'élément Object. La valeur textuelle de l'élément Default spécifie la valeur par défaut de l'objet lorsque vous insérez l'extrait de code.
Éventuellement, ajoutez les éléments Fonction et/ou Info-bulle.

Référencement des remplacements

À présent que vous avez créé des littéraux et des objets, il vous faut un moyen de les utiliser dans le code qui sera inséré par l'extrait de code. Vous référencez les littéraux et les objets que vous avez déclarés dans l'élément Declarations en plaçant des symboles $ au début et à la fin de la valeur dans l'élément ID du littéral ou de l'objet.

Pour référencer un littéral ou un objet dans un élément de code

Placez les symboles $ au début et à la fin de la valeur de l'élément ID du littéral ou de l'objet. Par exemple, si un littéral a un élément ID qui contient la valeur MyID, vous référenceriez ce littéral dans l'élément Code avec $MyID$.

Exemple

L'exemple de code suivant affiche un extrait de code avec à la fois les éléments Literal et Object. Le littéral SqlConnString est référencé dans l'élément Code avec $SqlConnString$, et l'objet SqlConnection est référencé avec $SqlConnection$.

<CodeSnippets xmlns="https://schemas.microsoft.com/VisualStudio/CodeSnippet">
    <CodeSnippet>
        <Header>

            <!-- Add Header information here -->

        </Header>
        <Snippet>

            <!-- Add additional Snippet information here -->

            <Declarations>
                <Literal>
                    <ID>SqlConnString</ID>
                    <ToolTip>Replace with a SQL connection string.</ToolTip>
                    <Default>"SQL connection string"</Default>
                </Literal>
                <Object>
                    <ID>SqlConnection</ID>
                    <Type>System.Data.SqlClient.SqlConnection</Type>
                    <ToolTip>Replace with a connection object in your application.</ToolTip>
                    <Default>dcConnection</Default>
                </Object>
            </Declarations>
            <Code Language="CSharp">
                <![CDATA[
                    daCustomers = new SqlClient.SqlDataAdapter();
                    selectCommand = new SqlClient.SqlCommand($SqlConnString$);
                    daCustomers.SelectCommand = selectCommand;
                    daCustomers.SelectCommand.Connection = $SqlConnection$;
                ]]>
            </Code>
        </Snippet>
    </CodeSnippet>
</CodeSnippets>