Partager via


Literal, élément (extraits de code IntelliSense)

Définit les champs littéraux de l'extrait de code que vous pouvez modifier.

<Literal Editable="true/false">
   <ID>... </ID>
   <ToolTip>... </ToolTip>
   <Default>... </Default>
   <Function>... </Function>
</Literal>

Attributs et éléments

Les sections suivantes décrivent des attributs, des éléments enfants et des éléments parents.

Attributs

Attribut

Description

Editable

Attribut Boolean facultatif.

Spécifie si vous pouvez ou non modifier le littéral après que l'extrait de code a été inséré.La valeur par défaut de cet attribut est true.

Éléments enfants

Élément

Description

Par défaut

Élément requis.

Spécifie la valeur par défaut du littéral lorsque vous insérez l'extrait de code.Un élément Literal doit contenir exactement un élément Default.

Fonction

Élément facultatif.

Spécifie une fonction à exécuter lorsque le littéral reçoit le focus dans Visual Studio.Il peut y avoir zéro ou un élément Function dans un élément Literal.

ID

Élément requis.

Spécifie l'identificateur unique du littéral.Un élément Literal doit contenir exactement un élément ID.

Info-bulle

Élément facultatif.

Décrit la valeur attendue et l'utilisation du littéral.Il peut y avoir zéro ou un élément Tooltip dans un élément Literal.

Éléments parents

Élément

Description

Déclarations

Contient les littéraux et les objets d'un extrait de code que vous pouvez modifier.

Notes

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.

Les littéraux et objets ne peuvent pas contenir d'élément ID ayant la valeur selected ou end.La valeur $selected$ représente le texte sélectionné dans le document qui sera inséré dans l'extrait de code lorsqu'il est appelé.$end$ marque l'emplacement pour placer le curseur après insertion de l'extrait de code.

Exemple

L'exemple de code suivant montre comment déclarer un littéral avec une valeur d'élément ID de SQL.Le littéral est référencé dans l'élément Code en utilisant le séparateur par défaut.Dans cet exemple, le littéral est référencé par $SQL$.

<CodeSnippets xmlns="https://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
    <CodeSnippet Format="1.0.0">
        <Header>
            <Title>Create a data adapter</Title>
            <Description>Creates a SqlDataAdapter object.</Description>
            <Author>Microsoft Corporation</Author>
            <Shortcut>createadapter</Shortcut>
        </Header>
        <Snippet>
            <Declarations>
                <Literal>
                    <ID>SQL</ID>
                    <ToolTip>Replace with a SQL connection string.</ToolTip>
                    <Default>"SQL connection string"</Default>
                </Literal>
                <Object>
                    <ID>Connection</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($SQL$);
                    daCustomers.SelectCommand = selectCommand;
                    daCustomers.SelectCommand.Connection = $Connection$;
                ]]>
            </Code>
        </Snippet>
    </CodeSnippet>
</CodeSnippets>

Voir aussi

Concepts

Référence de schéma des extraits de code