Référence de schéma des extraits de codeCode Snippets Schema Reference

Les extraits de code IntelliSense sont des parties de code précréées et prêtes à être insérées dans votre application avec Visual StudioVisual Studio.IntelliSense Code Snippets are pre-authored pieces of code that are ready to be inserted into your application with Visual StudioVisual Studio. Vous pouvez augmenter la productivité en fournissant des extraits de code qui réduisent le nombre d'heures passées à taper un code répétitif ou à rechercher des exemples.You can increase productivity by providing code snippets that reduce the amount of time spent typing repetitive code or searching for samples. Vous pouvez utiliser le schéma XML des extraits de code IntelliSense pour créer vos propres extraits de code et les ajouter aux extraits de code que Visual StudioVisual Studio contient déjà.You can use the IntelliSense Code Snippet XML schema to create your own code snippets and add them to the code snippets that Visual StudioVisual Studio already includes.

Éléments du schéma des extraits de code IntelliSenseIntelliSense Code Snippets Schema Elements

Assembly, élémentAssembly Element HelpUrl, élémentHelpUrl Element References, élémentReferences Element
Author, élémentAuthor Element ID, élémentID Element Shortcut, élémentShortcut Element
Code, élémentCode Element Import, élémentImport Element Snippet, élémentSnippet Element
CodeSnippet, élémentCodeSnippet Element Imports, élémentImports Element SnippetType, élémentSnippetType Element
CodeSnippets, élémentCodeSnippets Element Keyword, élémentKeyword Element SnippetTypes, élémentSnippetTypes Element
Declarations, élémentDeclarations Element Keywords, élémentKeywords Element Title, élémentTitle Element
Default, élémentDefault Element Literal, élémentLiteral Element ToolTip, élémentToolTip Element
Description, élémentDescription Element Namespace, élémentNamespace Element Type, élémentType Element
Function, élémentFunction Element Object, élémentObject Element Url, élémentUrl Element
Header, élémentHeader Element Reference, élémentReference Element

Assembly, élémentAssembly Element

Spécifie le nom de l'assembly référencé par l'extrait de code.Specifies the name of the assembly referenced by the code snippet.

La valeur du texte de l’élément Assembly correspond soit au nom convivial de l’assembly, comme System.dll, soit à son nom fort, comme System,Version=1.0.0.1,Culture=neutral,PublicKeyToken=9b35aa323c18d4fb1.The text value of the Assembly element is either the friendly text name of the assembly, such as System.dll, or its strong name, such as System,Version=1.0.0.1,Culture=neutral,PublicKeyToken=9b35aa323c18d4fb1.

<Assembly>  
    AssemblyName  
</Assembly>  
Parent, élémentParent Element DescriptionDescription
Reference, élémentReference Element Contient des informations à propos des références d'assembly requises par l'extrait de code.Contains information about assembly references required by the code snippet.

Une valeur texte est requise.A text value is required. Ce texte spécifie l'assembly auquel l'extrait de code fait référence.This text specifies the assembly that the code snippet references.

Author, élémentAuthor Element

Spécifie le nom de l'auteur de l'extrait de code.Specifies the name of the snippet author. Le Gestionnaire des extraits de code affiche le nom stocké dans l’élément Author de l’extrait de code.The Code Snippets Manager displays the name stored in the Author element of the code snippet.

<Author>  
   Code Snippet Author  
</Author>    
Parent, élémentParent Element DescriptionDescription
Header, élémentHeader Element Contient des informations générales sur l'extrait de code.Contains general information about the code snippet.

Une valeur texte est requise.A text value is required. Ce texte spécifie l'auteur de l'extrait de code.This text specifies the author of the code snippet.

Élément Code Code Element

Fournit de petits blocs d'extraits de code à un conteneur.Provides a container for short code blocks.

Mots clésKeywords

Deux mots réservés peuvent être utilisés dans le texte de l'élément Code : $end$ et $selected$.Two reserved words are available for use in the text of the Code element: $end$ and $selected$. $end$ marque l'emplacement pour placer le curseur après insertion de l'extrait de code.$end$ marks the location to place the cursor after the code snippet is inserted. $selected$ représente le texte sélectionné dans le document qui sera inséré dans l'extrait de code lorsqu'il est appelé.$selected$ represents text selected in the document that is to be inserted into the snippet when it is invoked. Par exemple, étant donné un extrait de code qui inclut :For example, given a snippet that includes:

$selected$ is a great color.  

et que le mot « Blue » est sélectionné lorsque l'utilisateur appelle le modèle, le résultat est le suivant :If the word "Blue" is selected when the user invokes the template, the result is:

Blue is a great color.  

Vous ne pouvez pas utiliser $end$ ou $selected$ plus d'une fois dans un extrait de code.You may not use either $end$ or $selected$ more than once in a code snippet. Si vous le faites, seule la deuxième instance est reconnue.If you do, only the second instance is recognized. Étant donné un extrait de code qui inclut :Given a snippet that includes:

$selected$ is a great color. I love $selected$.  

si le mot « Blue » est sélectionné, le résultat est le suivant :If the word "Blue" is selected, the result is:

 is a great color. I love Blue.  

L'espace initial s'affiche car il y a un espace entre $selected$ et is.The initial space appears because there is a space between $selected$ and is.

Tous les autres mots clés $ sont définis dynamiquement dans les balises <Literal> et <Object>.All other $ keywords are dynamically defined in the <Literal> and <Object> tags.

Voici la structure de l’élément Code :Following is the structure of the Code element:

<Code Language="Language"  
    Kind="method body/method decl/type decl/page/file/any"  
    Delimiter="Delimiter">  
    Code to insert  
</Code>  

Une valeur texte est requise.A text value is required. Ce texte spécifie le code, avec les littéraux et les objets, que vous pouvez utiliser quand cet extrait de code est inséré dans un fichier de code.This text specifies the code, along with the literals and objects, that you can use when this code snippet is inserted into a code file.

AttributsAttributes

Trois attributs sont disponibles pour l’élément Code :There are three attributes available for the Code element:

  • Langage - Attribut obligatoire qui spécifie le langage de l’extrait de code.Language - Required attribute that specifies the language of the code snippet. Il peut avoir l’une des valeurs suivantes :The value can be one of the following:

    ValueValue DescriptionDescription
    VB Identifie un extrait de code Visual Basic.Identifies a Visual Basic code snippet.
    CSharp Identifie un extrait de code C#.Identifies a C# code snippet.
    CPP Identifie un extrait de code C++.Identifies a C++ code snippet.
    XML Identifie un extrait de code XML.Identifies an XML code snippet.
    JavaScript Identifie un extrait de code JavaScript.Identifies a JavaScript code snippet.
    SQL Identifie un extrait de code SQL.Identifies a SQL code snippet.
    HTML Identifie un extrait de code HTML.Identifies an HTML code snippet.
  • Kind - Attribut facultatif qui spécifie le type de code contenu dans l’extrait de code, ainsi que l’emplacement auquel un extrait de code doit être inséré pour pouvoir être compilé.Kind - Optional attribute that specifies the kind of code that the snippet contains, and the location at which a code snippet must be inserted for the code snippet to compile. Il peut avoir l’une des valeurs suivantes :The value can be one of the following:

    ValueValue DescriptionDescription
    method body Spécifie que l'extrait de code est un corps de méthode, et par conséquent, qu'il doit être inséré à l'intérieur d'une déclaration de méthode.Specifies that the code snippet is a method body, and therefore, must be inserted inside a method declaration.
    method decl Spécifie que l'extrait de code est une méthode, et par conséquent, qu'il doit être inséré à l'intérieur d'une classe ou d'un module.Specifies that the code snippet is a method, and therefore, must be inserted inside a class or module.
    type decl Spécifie que l'extrait de code est un type, et par conséquent, qu'il doit être inséré à l'intérieur d'une classe, d'un module ou d'un espace de noms.Specifies that the code snippet is a type, and therefore, must be inserted inside a class, module, or namespace.
    file Spécifie que l'extrait de code est un fichier de code complet.Specifies that the snippet is a full code file. Ces extraits de code peuvent être insérés seuls dans un fichier de code, ou à l'intérieur d'un espace de noms.These code snippets can be inserted alone into a code file, or inside a namespace.
    any Spécifie que l'extrait de code peut être inséré n'importe où.Specifies that the snippet can be inserted anywhere. Cette balise est utilisée pour les extraits de code indépendants du contexte, comme les commentaires.This tag is used for code snippets that are context-independent, such as comments.
  • Delimiter - Attribut facultatif qui spécifie le délimiteur utilisé pour décrire les littéraux et les objets contenus dans le code.Delimiter - Optional attribute that specifies the delimiter used to describe literals and objects in the code. Par défaut, le délimiteur est $.By default, the delimiter is $.

Élément parentParent element

Parent, élémentParent Element DescriptionDescription
Snippet, élémentSnippet Element Contient les références, importations, déclarations et code de l'extrait de code.Contains the references, imports, declarations, and code for the code snippet.

CodeSnippet, élémentCodeSnippet Element

Vous permet de spécifier un titre et plusieurs extraits de code IntelliSense que vous pouvez insérer dans des fichiers de Visual Studio Code.Allows you to specify a heading and multiple IntelliSense Code Snippets, which you can insert into Visual Studio code files.

<CodeSnippet Format="x.x.x">  
    <Header>... </Header>  
    <Snippet>... </Snippet>  
</CodeSnippet>  
AttributAttribute DescriptionDescription
Format Attribut requis.Required attribute. Spécifie la version de schéma de l'extrait de code.Specifies the schema version of the code snippet. L'attribut Format doit être une chaîne dont la syntaxe est x.x.x, où chaque "x" représente une valeur numérique du numéro de version.The Format attribute must be a string in the syntax of x.x.x, where each "x" represents a numerical value of the version number. Visual Studio ignore les extraits de code dont il ne comprend pas les attributs Format.Visual Studio will ignore code snippets with Format attributes that it does not understand.
Élément enfantChild Element DescriptionDescription
Header, élémentHeader Element Élément requis.Required element. Contient des informations générales sur l'extrait de code.Contains general information about the code snippet. Il doit y avoir un seul élément Header dans un extrait de code.There must be exactly one Header element in a code snippet.
Snippet, élémentSnippet Element Élément requis.Required element. Contient le code qui sera inséré par Visual Studio.Contains the code that will be inserted by Visual Studio. Il doit y avoir un seul élément Snippet dans un extrait de code.There must be exactly one Snippet element in a code snippet.
Parent, élémentParent Element DescriptionDescription
CodeSnippets, élémentCodeSnippets Element Élément racine du schéma XML de l'extrait de code.Root element of the code snippet XML schema.

CodeSnippets, élémentCodeSnippets Element

Regroupe les éléments CodeSnippet.Groups CodeSnippet Elementelements. L'élément CodeSnippets est l'élément racine du schéma XML de l'extrait de code.The CodeSnippets element is the root element of the code snippet XML schema.

<CodeSnippets>  
    <CodeSnippet>... </CodeSnippet>  
</CodeSnippets>  
Élément enfantChild Element DescriptionDescription
CodeSnippet, élémentCodeSnippet Element Élément facultatif.Optional element. Élément parent pour toutes les données d'extrait de code.Parent element for all code snippet data. Un élément CodeSnippet peut ne contenir aucun élément CodeSnippets ou en contenir plusieurs.There may be zero or more CodeSnippet elements in a CodeSnippets element.

Declarations, élémentDeclarations Element

Spécifie les littéraux et les objets qui composent un extrait de code que vous pouvez modifier.Specifies the literals and objects that make up the parts of a code snippet that you can edit.

<Declarations>  
    <Literal>... </Literal>  
    <Object>... </Object>  
</Declarations>  
Élément enfantChild Element DescriptionDescription
Literal, élémentLiteral Element Élément facultatif.Optional element. Définit les littéraux de l'extrait de code que vous pouvez modifier.Defines the literals of the code snippet that you can edit. Un élément Literal peut ne contenir aucun élément Declarations ou en contenir plusieurs.There may be zero or more Literal elements in a Declarations element.
Object, élémentObject Element Élément facultatif.Optional element. Définit les objets de l'extrait de code que vous pouvez modifier.Defines the objects of the code snippet that you can edit. Un élément Object peut ne contenir aucun élément Declarations ou en contenir plusieurs.There may be zero or more Object elements in a Declarations element.
Parent, élémentParent Element DescriptionDescription
Snippet, élémentSnippet Element Contient les références, importations, déclarations et code de l'extrait de code.Contains the references, imports, declarations, and code for the code snippet.

Default, élémentDefault Element

Spécifie la valeur par défaut du littéral ou de l'objet d'un extrait de code IntelliSense.Specifies the default value of the literal or object for an IntelliSense Code Snippet.

<Default>  
    Default value  
</Default>  
Parent, élémentParent Element DescriptionDescription
Literal, élémentLiteral Element Définit les champs littéraux de l'extrait de code que vous pouvez modifier.Defines the literal fields of the code snippet that you can edit.
Object, élémentObject Element Définit les champs objet de l'extrait de code que vous pouvez modifier.Defines the object fields of the code snippet that you can edit.

Une valeur texte est requise.A text value is required. Ce texte spécifie la valeur par défaut du littéral ou de l'objet qui remplit les champs de l'extrait de code que vous pouvez modifier.This text specifies the default value of the literal or object that fills the fields of the code snippet that you can edit.

Description, élémentDescription Element

Spécifie des informations relatives à la description du contenu d'un extrait de code IntelliSense.Specifies descriptive information about the contents of an IntelliSense Code Snippet.

<Description>  
    Code Snippet Description  
</Description>  
Parent, élémentParent Element DescriptionDescription
Header, élémentHeader Element Contient des informations générales sur l'extrait de code.Contains general information about the code snippet.

Une valeur texte est requise.A text value is required. Ce texte décrit l'extrait de code.This text describes the code snippet.

Function, élémentFunction Element

Spécifie une fonction à exécuter lorsque le littéral ou l'objet reçoit le focus dans Visual Studio.Specifies a function to execute when the literal or object receives focus in Visual Studio.

Note

L'élément Function est uniquement pris en charge par les extraits de code C#.The Function element is only supported in C# code snippets.

<Function>  
    FunctionName  
</Function>  
Parent, élémentParent Element DescriptionDescription
Literal, élémentLiteral Element Définit les champs littéraux de l'extrait de code que vous pouvez modifier.Defines the literal fields of the code snippet that you can edit.
Object, élémentObject Element Définit les champs objet de l'extrait de code que vous pouvez modifier.Defines the object fields of the code snippet that you can edit.

Une valeur texte est requise.A text value is required. Ce texte spécifie une fonction à exécuter lorsque le littéral ou le champ objet reçoit le focus dans Visual Studio.This text specifies a function to execute when the literal or object field receives focus in Visual Studio.

Spécifie des informations d'ordre général sur l'extrait de code IntelliSense.Specifies general information about the IntelliSense Code Snippet.

<Header>  
    <Title>... </Title>  
    <Author>... </Author>  
    <Description>... </Description>  
    <HelpUrl>... </HelpUrl>  
    <SnippetTypes>... </SnippetTypes>  
    <Keywords>... </Keywords>  
    <Shortcut>... </Shortcut>  
</Header>  
Élément enfantChild Element DescriptionDescription
Author, élémentAuthor Element Élément facultatif.Optional element. Nom de la personne ou de la société qui a créé l'extrait de code.The name of the person or company that authored the code snippet. Il peut y avoir zéro ou un élément Author dans un élément Header.There may be zero or one Author elements in a Header element.
Description, élémentDescription Element Élément facultatif.Optional element. Description de l'extrait de code.A description of the code snippet. Il peut y avoir zéro ou un élément Description dans un élément Header.There may be zero or one Description elements in a Header element.
HelpUrl, élémentHelpUrl Element Élément facultatif.Optional element. URL contenant plus d'informations sur l'extrait de code.A URL that contains more information about the code snippet. Il peut y avoir zéro ou un élément HelpURL dans un élément .There may be zero or one HelpURL elements in a Header element. Remarque : Visual Studio n’utilise pas l’élément HelpUrl.Note: Visual Studio does not use the HelpUrl element. L'élément fait partie du schéma XML des extraits de code IntelliSense et tout extrait de code contenant l'élément est validé mais la valeur de l'élément n'est jamais utilisée.The element is part of the IntelliSense Code Snippet XML schema and any code snippet containing the element will validate, but the value of the element is never used.
Keywords, élémentKeywords Element Élément facultatif.Optional element. Groupe les éléments Keyword.Groups Keyword elements. Il peut y avoir zéro ou un élément Keywords dans un élément Header.There may be zero or one Keywords elements in a Header element.
Shortcut, élémentShortcut Element Élément facultatif.Optional element. Spécifie le texte du raccourci qui peut être utilisé pour insérer l'extrait de code.Specifies the shortcut text that can be used to insert the snippet. Il peut y avoir zéro ou un élément Shortcut dans un élément Header.There may be zero or one Shortcut elements in a Header element.
SnippetTypes, élémentSnippetTypes Element Élément facultatif.Optional element. Groupe les éléments SnippetType.Groups SnippetType elements. Il peut y avoir zéro ou un élément SnippetTypes dans un élément Header.There may be zero or one SnippetTypes elements in a Header element. S'il n'y a pas d'éléments SnippetTypes, l'extrait de code est toujours valide.If there are no SnippetTypes elements, the code snippet is always valid.
Title, élémentTitle Element Élément requis.Required element. Nom convivial de l'extrait de code.The friendly name of the code snippet. Un élément Title doit contenir exactement un élément Header.There must be exactly one Title element in a Header element.
Parent, élémentParent Element DescriptionDescription
CodeSnippet, élémentCodeSnippet Element Élément parent pour toutes les données d'extrait de code.Parent element for all code snippet data.

HelpUrl, élémentHelpUrl Element

Spécifie une URL qui fournit des informations supplémentaires sur un extrait de code.Specifies a URL that provides more information about a code snippet.

Note

Visual Studio n'utilise pas l'élément HelpUrl.Visual Studio does not use the HelpUrl element. L'élément fait partie du schéma XML des extraits de code IntelliSense et tout extrait de code contenant l'élément est validé mais la valeur de l'élément n'est jamais utilisée.The element is part of the IntelliSense Code Snippet XML schema and any code snippet containing the element will validate, but the value of the element is never used.

<HelpUrl>  
    www.microsoft.com  
</HelpUrl>  
Parent, élémentParent Element DescriptionDescription
Header, élémentHeader Element Contient des informations générales sur l'extrait de code.Contains general information about the code snippet.

Une valeur texte est facultative.A text value is optional. Ce texte spécifie l'URL à visiter pour plus d'informations sur un extrait de code.This text specifies the URL to visit for more information about a code snippet.

ID, élémentID Element

Spécifie l'identificateur unique d'un élément Literal ou Object.Specifies a unique identifier for a Literal or Object element. Deux objets ou littéraux d'un même extrait de code ne peuvent avoir la même valeur texte dans leurs éléments ID. Les littéraux et objets ne peuvent pas contenir d'élément ID avec une valeur de fin.No two literals or objects in the same code snippet can have the same text value in their ID elements.Literals and objects cannot contain an ID element with a value of end. La valeur $end$ est réservée et utilisée pour marquer l'emplacement du curseur après que l'extrait de code a été inséré.The value $end$ is reserved, and is used to mark the location to place the cursor after the code snippet is inserted.

<ID>  
    Unique Identifier  
</ID>  
Parent, élémentParent Element DescriptionDescription
Literal, élémentLiteral Element Définit les champs littéraux de l'extrait de code que vous pouvez modifier.Defines the literal fields of the code snippet that you can edit.
Object, élémentObject Element Définit les champs objet de l'extrait de code que vous pouvez modifier.Defines the object fields of the code snippet that you can edit.

Une valeur texte est requise.A text value is required. Ce texte spécifie l'identificateur unique de l'objet ou du littéral.This text specifies the unique identifier for the object or literal.

Import, élémentImport Element

Spécifie les espaces de noms importés et utilisés par un extrait de code IntelliSense.Specifies the imported namespaces used by an IntelliSense Code Snippet.

Note

L'élément Import est uniquement pris en charge pour les projets Visual Basic.The Import element is only supported for Visual Basic projects.

<Import>  
    <Namespace>... </Namespace>  
</Import>  
Élément enfantChild Element DescriptionDescription
Namespace, élémentNamespace Element Élément requis.Required element. Spécifie l'espace de noms utilisé par l'extrait de code.Specifies the namespace used by the code snippet. Un élément Namespace doit contenir exactement un élément Import.There must be exactly one Namespace element in an Import element.
Parent, élémentParent Element DescriptionDescription
Imports, élémentImports Element Élément grouping pour les éléments Import.Grouping element for Import elements.

Importations, élémentImports Element

Groupe des éléments Import individuels.Groups individual Import elements.

Note

L'élément Imports est uniquement pris en charge pour les projets Visual Basic.The Imports element is only supported for Visual Basic projects.

<Imports>  
    <Import>... </Import>  
<Imports>  
Élément enfantChild Element DescriptionDescription
Import, élémentImport Element Élément facultatif.Optional element. Contient les espaces de noms importés pour l'extrait de code.Contains the imported namespaces for the code snippet. Un élément Import peut ne contenir aucun élément Imports ou en contenir plusieurs.There may be zero or more Import elements in an Imports element.
Parent, élémentParent Element DescriptionDescription
Snippet, élémentSnippet Element Contient les références, importations, déclarations et code de l'extrait de code.Contains the references, imports, declarations, and code for the code snippet.

Keyword, élémentKeyword Element

Spécifie un mot clé personnalisé pour l'extrait de code.Specifies a custom keyword for the code snippet. Les mots clés d'extrait de code sont utilisés par Visual Studio et représentent une manière standard pour les fournisseurs de contenu en ligne d'ajouter des mots clés personnalisés pour les recherches ou la catégorisation.The code snippet keywords are used by Visual Studio and represent a standard way for online content providers to add custom keywords for searching or categorization.

<Keyword>  
    Code Snippet Keyword  
</Keyword>  
Parent, élémentParent Element DescriptionDescription
Keywords, élémentKeywords Element Groupe des éléments Keyword individuels.Groups individual Keyword elements.

Une valeur texte est requise.A text value is required. Mot clé pour l'extrait de code.The keyword for the code snippet.

Keywords, élémentKeywords Element

Groupe des éléments Keyword individuels.Groups individual Keyword elements. Les mots clés d'extrait de code sont utilisés par Visual Studio et représentent une manière standard pour les fournisseurs de contenu en ligne d'ajouter des mots clés personnalisés pour les recherches ou la catégorisation.The code snippet keywords are used by Visual Studio and represent a standard way for online content providers to add custom keywords for searching or categorization

<Keywords>  
    <Keyword>... </Keyword>  
    <Keyword>... </Keyword>  
<Keywords>  
Élément enfantChild Element DescriptionDescription
Keyword, élémentKeyword Element Élément facultatif.Optional element. Contient les mots clés de l'extrait de code.Contains individual keywords for the code snippet. Un élément Keyword peut ne contenir aucun élément Keywords ou en contenir plusieurs.There may be zero or more Keyword elements in a Keywords element.
Parent, élémentParent Element DescriptionDescription
Header, élémentHeader Element Contient des informations générales sur l'extrait de code.Contains general information about the code snippet.

Literal, élémentLiteral Element

Définit les littéraux de l'extrait de code que vous pouvez modifier.Defines the literals of the code snippet that you can edit. 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.The Literal element is used to identify a replacement for a piece of code that is entirely contained within the snippet, but will likely be customized after it is inserted into the code. Par exemple, les chaînes littérales, les valeurs numériques et certains noms de variables doivent être déclarés comme des littéraux.For example, literal strings, numeric values, and some variable names should be declared as literals.

Les littéraux et les objets ne peuvent pas contenir d’élément ID avec la valeur selected ou end.Literals and objects cannot contain an ID element with a value of selected or 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é.The value $selected$ represents text selected in the document that is to be inserted into the snippet when it is invoked. $end$ marque l'emplacement pour placer le curseur après insertion de l'extrait de code.$end$ marks the location to place the cursor after the code snippet is inserted.

<Literal Editable="true/false">  
   <ID>... </ID>  
   <ToolTip>... </ToolTip>  
   <Default>... </Default>  
   <Function>... </Function>  
</Literal>  
AttributAttribute DescriptionDescription
Editable Attribut Boolean facultatif.Optional Boolean attribute. Spécifie si vous pouvez modifier ou non le littéral une fois l'extrait de code inséré.Specifies whether or not you can edit the literal after the code snippet is inserted. La valeur par défaut de cet attribut est true.The default value of this attribute is true.
Élément enfantChild Element DescriptionDescription
Default, élémentDefault Element Élément requis.Required element. Spécifie la valeur par défaut du littéral lorsque vous insérez l'extrait de code.Specifies the literal's default value when you insert the code snippet. Un élément Default doit contenir exactement un élément Literal.There must be exactly one Default element in a Literal element.
Function, élémentFunction Element Élément facultatif.Optional element. Spécifie une fonction à exécuter lorsque le littéral reçoit le focus dans Visual Studio.Specifies a function to execute when the literal receives focus in Visual Studio. Il peut y avoir zéro ou un élément Function dans un élément Literal.There may be zero or one Function elements in a Literal element.
ID, élémentID Element Élément requis.Required element. Spécifie l'identificateur unique du littéral.Specifies a unique identifier for the literal. Un élément ID doit contenir exactement un élément Literal.There must be exactly one ID element in a Literal element.
ToolTip, élémentToolTip Element Élément facultatif.Optional element. Décrit la valeur attendue et l'utilisation du littéral.Describes the expected value and usage of the literal. Un élément peut contenir zéro ou un élément TooltipLiteral.There may be zero or one Tooltip elements in a Literal element.
Parent, élémentParent Element DescriptionDescription
Declarations, élémentDeclarations Element Contient les littéraux et les objets d'un extrait de code que vous pouvez modifier.Contains the literals and objects of a code snippet that you can edit.

Namespace, élémentNamespace Element

Spécifie l'espace de noms qui doit être importé pour compiler l'extrait de code et l'exécuter.Specifies the namespace that must be imported for the code snippet to compile and run. L'espace de noms spécifié dans l'élément Namespace est ajouté automatiquement au début du code à une instruction Imports, s'il n'y figure pas déjà.The namespace specified in the Namespace element is automatically added to an Imports statement at the beginning of the code, if it does not already exist.

Note

L'élément Namespace est uniquement pris en charge pour les projets Visual Basic.The Namespace element is only supported for Visual Basic projects.

<Namespace>  
    Namespace  
</Namespace>  
Parent, élémentParent Element DescriptionDescription
Import, élémentImport Element Importe l'espace de noms spécifié.Imports the specified namespace.

Une valeur texte est requise.A text value is required. Ce texte spécifie un espace de noms que l'extrait de code considère comme importé.This text specifies a namespace that the code snippet assumes is imported.

Object, élémentObject Element

Définit les objets de l'extrait de code que vous pouvez modifier.Defines the objects of the code snippet that you can edit. 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.The Object element is used to identify an item that is required by the code snippet but is likely to be defined outside of the snippet itself. 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.For example, Windows Forms controls, ASP.NET controls, object instances, and type instances should be declared as objects. Les déclarations d'objet requièrent qu'un type soit spécifié, ce qui est fait avec l'élément Type.Object declarations require that a type be specified, which is done with the Type element.

<Object Editable="true/false">  
    <ID>... </ID>  
    <Type>... </Type>  
    <ToolTip>... </ToolTip>  
    <Default>... </Default>  
    <Function>... </Function>  
</Object>  
AttributAttribute DescriptionDescription
Editable Attribut Boolean facultatif.Optional Boolean attribute. Spécifie si vous pouvez modifier ou non le littéral une fois l'extrait de code inséré.Specifies whether or not you can edit the literal after the code snippet is inserted. La valeur par défaut de cet attribut est true.The default value of this attribute is true.
Élément enfantChild Element DescriptionDescription
Default, élémentDefault Element Élément requis.Required element. Spécifie la valeur par défaut du littéral lorsque vous insérez l'extrait de code.Specifies the literal's default value when you insert the code snippet. Un élément Default doit contenir exactement un élément Literal.There must be exactly one Default element in a Literal element.
Function, élémentFunction Element Élément facultatif.Optional element. Spécifie une fonction à exécuter lorsque le littéral reçoit le focus dans Visual Studio.Specifies a function to execute when the literal receives focus in Visual Studio. Il peut y avoir zéro ou un élément Function dans un élément Literal.There may be zero or one Function elements in a Literal element.
ID, élémentID Element Élément requis.Required element. Spécifie l'identificateur unique du littéral.Specifies a unique identifier for the literal. Un élément ID doit contenir exactement un élément Literal.There must be exactly one ID element in a Literal element.
ToolTip, élémentToolTip Element Élément facultatif.Optional element. Décrit la valeur attendue et l'utilisation du littéral.Describes the expected value and usage of the literal. Un élément peut contenir zéro ou un élément TooltipLiteral.There may be zero or one Tooltip elements in a Literal element.
Type, élémentType Element Élément requis.Required element. Spécifie le type de l'objet.Specifies the type of the object. Un élément Type doit contenir exactement un élément Object.There must be exactly one Type element in an Object element.
Parent, élémentParent Element DescriptionDescription
Declarations, élémentDeclarations Element Contient les littéraux et les objets d'un extrait de code que vous pouvez modifier.Contains the literals and objects of a code snippet that you can edit.

Reference, élémentReference Element

Spécifie des informations sur les références d'assembly requises par l'extrait de code.Specifies information about the assembly references required by the code snippet.

<Reference>  
    <Assembly>... </Assembly>  
    <Url>... </Url>  
</Reference>  
Élément enfantChild Element DescriptionDescription
Assembly, élémentAssembly Element Élément requis.Required element. Spécifie le nom de l'assembly référencé par l'extrait de code.Contains the name of the assembly referenced by the code snippet. Un élément Assembly doit contenir exactement un élément Reference.There must be exactly one Assembly element in a Reference element.
Url, élémentUrl Element Élément facultatif.Optional element. Contient une URL qui fournit plus d'informations sur l'assembly référencé.Contains a URL that provides more information about the referenced assembly. Il peut y avoir zéro ou un élément Url dans un élément Reference.There may be zero or one Url elements in a Reference element.
Parent, élémentParent Element DescriptionDescription
References, élémentReferences Element Élément de regroupement pour les éléments Reference.Grouping element for Reference elements.

References, élémentReferences Element

Groupe des éléments Reference individuels.Groups individual Reference elements.

<References>  
    <Reference>... </Reference>  
</References>  
Élément enfantChild Element DescriptionDescription
Reference, élémentReference Element Élément facultatif.Optional element. Contient des informations à propos des références d'assembly de l'extrait de code.Contains information about assembly references for the code snippet. Un élément Reference peut ne contenir aucun élément References ou en contenir plusieurs.There may be zero or more Reference elements in a References element.
Parent, élémentParent Element DescriptionDescription
Snippet, élémentSnippet Element Contient les références, importations, déclarations et code de l'extrait de code.Contains the references, imports, declarations, and code for the code snippet.

Shortcut, élémentShortcut Element

Spécifie le texte de raccourci utilisé pour insérer l'extrait de code.Specifies the shortcut text used to insert the snippet. La valeur texte d'un élément Shortcut peut contenir uniquement des signes alphanumériques, des traits d'union (-) et des traits de soulignement ().The text value of a Shortcut element can only contain alphanumeric characters, hyphens ( - ), and underscores ( ).

Attention

et - ne sont pas des caractères pris en charge dans les raccourcis de l’extrait de code C++. and - are not supported characters in C++ snippet shortcuts.

<Shortcut>  
    Shortcut Text  
</Shortcut>  
Parent, élémentParent Element DescriptionDescription
Header, élémentHeader Element Contient des informations générales sur l'extrait de code.Contains general information about the code snippet.

Une valeur texte est facultative.A text value is optional. Ce texte est utilisé comme raccourci pour insérer l'extrait de code.This text is used as a shortcut for inserting the code snippet.

Snippet, élémentSnippet Element

Spécifie les références, les importations, les déclarations et le code de l'extrait de code.Specifies the references, imports, declarations, and code for the code snippet.

<Snippet>  
    <References>... </References>  
    <Imports>... </Imports>  
    <Declarations>... </Declarations>  
    <Code>... </Code>  
</Snippet>    
Élément enfantChild Element DescriptionDescription
Code, élémentCode Element Élément requis.Required element. Spécifie le code que vous souhaitez insérer dans un fichier documentation.Specifies the code that you want to insert into a documentation file. Un élément Code doit contenir exactement un élément Snippet.There must be exactly one Code element in a Snippet element.
Declarations, élémentDeclarations Element Élément facultatif.Optional element. Spécifie les littéraux et les objets qui composent un extrait de code que vous pouvez modifier.Specifies the literals and objects that make up the parts of a code snippet that you can edit. Il peut y avoir zéro ou un élément Declarations dans un élément Snippet.There may be zero or one Declarations elements in a Snippet element.
Imports, élémentImports Element Élément facultatif.Optional element. Groupe des éléments Import individuels.Groups individual Import elements. Il peut y avoir zéro ou un élément Imports dans un élément Snippet.There may be zero or one Imports elements in a Snippet element.
Élément facultatif.Optional element. Groupe des éléments Reference individuels.Groups individual Reference elements. Il peut y avoir zéro ou un élément References dans un élément Snippet.There may be zero or one References elements in a Snippet element.
Parent, élémentParent Element DescriptionDescription
CodeSnippet, élémentCodeSnippet Element Vous permet de spécifier un titre et plusieurs extraits de code IntelliSense que vous pouvez insérer dans des fichiers de Visual Studio Code.Allows you to specify a heading and multiple IntelliSense Code Snippets, which you can insert into Visual Studio code files.

SnippetType, élémentSnippetType Element

Spécifie la manière dont Visual Studio insère l'extrait de code.Specifies how Visual Studio inserts the code snippet.

<SnippetType>  
    SurroundsWith/Expansion  
<SnippetType>  
Parent, élémentParent Element DescriptionDescription
SnippetTypes, élémentSnippetTypes Element Groupe les éléments SnippetType.Groups SnippetType elements.

Le texte doit avoir l'une des valeurs suivantes :The text value must be one of the following values:

  • SurroundsWith : autorise à placer l'extrait de code autour d'une partie de code sélectionnée.SurroundsWith: allows the code snippet to be placed around a selected piece of code.

  • Expansion : autorise à insérer l'extrait de code au curseur.Expansion: allows the code snippet to be inserted at the cursor.

  • Refactoring : spécifie que l'extrait de code est utilisé pendant la refactorisation C#.Refactoring: specifies that the code snippet is used during C# refactoring. Refactoring ne peut pas être utilisé dans les extraits de code personnalisés.Refactoring cannot be used in custom code snippets.

SnippetTypes, élémentSnippetTypes Element

Groupe des éléments SnippetType individuels.Groups individual SnippetType elements. Si l'élément SnippetTypes est absent, l'extrait de code peut être inséré n'importe où dans le code.If the SnippetTypes element is not present, the code snippet can be inserted anywhere in the code.

<SnippetTypes>  
    <SnippetType>... </SnippetType>  
    <SnippetType>... </SnippetType>  
<SnippetTypes>  
Élément enfantChild Element DescriptionDescription
SnippetType, élémentSnippetType Element Élément facultatif.Optional element. Spécifie la manière dont Visual Studio insère l'extrait de code dans le code.Specifies how Visual Studio inserts the code snippet into the code. Un élément SnippetType peut ne contenir aucun élément SnippetTypes ou en contenir plusieurs.There may be zero or more SnippetType elements in a SnippetTypes element.
Parent, élémentParent Element DescriptionDescription
Header, élémentHeader Element Spécifie des informations générales sur l'extrait de code.Specifies general information about the code snippet.

Title, élémentTitle Element

Spécifie le titre de l'extrait de code.Specifies the title for the code snippet. Le titre stocké dans l’élément Title de l’extrait de code apparaît dans le Sélecteur d’extraits de code, ainsi que dans la description de l’extrait de code située dans le Gestionnaire des extraits de code.The title stored in the Title element of the code snippet appears in the Code Snippet Picker and in the code snippet's description in the Code Snippets Manager.

<Title>  
    Code Snippet Title  
<Title>  
Parent, élémentParent Element DescriptionDescription
Header, élémentHeader Element Spécifie des informations générales sur l'extrait de code.Specifies general information about the code snippet.

Une valeur texte est requise.A text value is required. Ce texte spécifie le titre de l'extrait de code.This text specifies the title of the code snippet.

ToolTip, élémentToolTip Element

Décrit la valeur attendue et l'utilisation d'un littéral ou d'un objet d'extrait de code que Visual Studio affiche dans une info-bulle lorsqu'il insère l'extrait de code dans un projet.Describes the expected value and usage of a literal or object in a code snippet, which Visual Studio displays in a ToolTip when it inserts the code snippet into a project. Le texte d'Info-bulle est affiché lorsque la souris pointe sur le littéral ou sur l'objet après que l'extrait de code a été inséré.The ToolTip text is displayed when the mouse hovers over the literal or object after the code snippet has been inserted.

<ToolTip>  
    ToolTip description  
</ToolTip>  
Parent, élémentParent Element DescriptionDescription
Literal, élémentLiteral Element Définit les champs littéraux de l'extrait de code que vous pouvez modifier.Defines the literal fields of the code snippet that you can edit.
Object, élémentObject Element Définit les champs objet de l'extrait de code que vous pouvez modifier.Defines the object fields of the code snippet that you can edit.

Une valeur texte est requise.A text value is required. Ce texte spécifie la description de l'info-bulle à associer à l'objet ou au littéral dans l'extrait de code.This text specifies the ToolTip description to be associated with the object or literal in the code snippet.

Type, élémentType Element

Spécifie le type de l'objet.Specifies the type of the object. 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.The Object element is used to identify an item that is required by the code snippet but is likely to be defined outside of the snippet itself. 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.For example, Windows Forms controls, ASP.NET controls, object instances, and type instances should be declared as objects. Les déclarations d'objet requièrent qu'un type soit spécifié, ce qui est fait avec l'élément Type.Object declarations require that a type be specified, which is done with the Type element.

<Type>  
    Type  
</Type>  
Parent, élémentParent Element DescriptionDescription
Object, élémentObject Element Définit les champs objet de l'extrait de code que vous pouvez modifier.Defines the object fields of the code snippet that you can edit.

Une valeur texte est requise.A text value is required. Ce texte spécifie le type de l'objet.This text specifies the type of the object.

Url, élémentUrl Element

Spécifie une URL qui fournit des informations supplémentaires sur l'assembly référencé.Specifies a URL that provides more information about the referenced assembly.

Note

L'élément Url est uniquement pris en charge pour les projets Visual Basic.The Url element is only supported for Visual Basic projects.

<Url>  
    www.microsoft.com  
</Url>  
Parent, élémentParent Element DescriptionDescription
Reference, élémentReference Element Spécifie les références d'assembly requises par l'extrait de code.Specifies the assembly references required by the code snippet.

Une valeur texte est requise.A text value is required. Ce texte spécifie une URL avec plus d'informations sur l'assembly référencé.This text specifies a URL with more information about the referenced assembly. Cette URL est affichée lorsque la référence ne peut pas être ajoutée au projet.This URL is displayed when the reference cannot be added to the project.

Voir aussiSee Also

Extraits de code Code Snippets
Procédure pas à pas : création d’un extrait de codeWalkthrough: Creating a Code Snippet