Comment : créer des extraits XMLHow to: Create XML snippets

Vous pouvez utiliser l'éditeur XML pour créer de nouveaux extraits XML.The XML Editor can be used to create new XML snippets. Cet éditeur comporte un extrait XML appelé « Snippet », qui est souvent utilisé pour la création de nouveaux extraits XML.The editor includes an XML snippet, named "Snippet", that is a boilerplate snippet for creating new XML snippets.

Pour créer un nouvel extrait XMLTo create a new XML snippet

Pour créer un nouveau code XML extrait de créer un nouveau fichier XML et utilisez la insérer un extrait fonctionnalité.To create a new XML code snippet create a new XML file and use the Insert Snippet feature.

  1. Sur le fichier menu, cliquez sur nouveau puis cliquez sur fichier.On the File menu, click New and then click File.

  2. Cliquez sur fichier XML puis cliquez sur ouvrir.Click XML File and then click Open.

  3. Avec le bouton droit dans le volet de l’éditeur et sélectionnez insérer un extrait.Right-click in the editor pane and select Insert Snippet.

  4. Sélectionnez extrait à partir de la liste et appuyez sur entrée.Select Snippet from the list and press Enter.

  5. Apportez les modifications voulues au nouvel extrait.Make any changes to the new snippet.

  6. À partir de la fichier menu Sélectionnez Enregistrer XMLFile.xml.From the File menu select Save XMLFile.xml.

    Le enregistrer le fichier sous boîte de dialogue s’affiche.The Save File As dialog box is displayed.

  7. Entrez le nom du nouvel extrait et sélectionnez extrait les fichiers à partir de la enregistrer en tant que type fenêtre déroulante.Enter the name for the new snippet and select Snippet Files from the Save as type drop-down window.

  8. Utilisez le enregistrer dans liste déroulante pour modifier l’emplacement de fichier pour le par Mes Documents\Visual Studio 2005\Code Snippets\XML\My XML Snippets dossier, puis appuyez sur enregistrer.Use the Save in drop-down list to change the file location to the My Documents\Visual Studio 2005\Code Snippets\XML\My XML Snippets folder and then press Save.

Description de l’extrait de codeSnippet description

Cette section décrit certains éléments clés de l'extrait souvent utilisé.This section describes some of the key elements in the boilerplate snippet. Pour plus d’informations sur les éléments de schéma utilisés par les extraits XML, consultez référence du schéma des extraits de Code.For more information about schema elements used by the XML snippets, see Code snippets schema reference.

SnippetType, élémentSnippetType element

L'éditeur prend en charge deux types d'extraits :The editor supports two snippet types:

<SnippetTypes>
  <SnippetType>SurroundsWith</SnippetType>
  <SnippetType>Expansion</SnippetType>
</SnippetTypes>

Le Expansion type détermine si l’extrait apparaît lorsque vous appelez le insérer un extrait commande.The Expansion type determines whether the snippet appears when you invoke the Insert Snippet command. Le SurroundsWith type détermine si l’extrait apparaît lorsque vous appelez le entourer commande.The SurroundsWith type determines whether the snippet appears when you invoke the Surrounds With command.

Élément de codeCode element

L'élément Code définit le texte XML qui sera inséré lorsque l'extrait sera appelé.The Code element defines the XML text that will be inserted when the snippet is invoked.

Note

Le texte de l'extrait XML doit être placé dans une section <![CDATA[...]]>.The XML snippet text must be enclosed in a <![CDATA[...]]> section.

L'élément Code suivant est créé par l'extrait souvent utilisé.The following is the Code element that is created by the boilerplate snippet.

<Code Language="XML">
  <![CDATA[<test>
  <name>$name$</name>
  $selected$ $end$</test>]]>
</Code>

L'élément Code inclut trois variables.The Code element includes three variables.

  • $name$ est une variable définie par l'utilisateur.$name$ is user-defined variable. Elle crée un élément name dont la valeur par défaut modifiable est « name ».It creates a name element, which has an editable value that defaults to "name". Les variables définies par l'utilisateur se définissent à l'aide de l'élément Literal.User-defined variables are defined using the Literal element.

  • $selected$ est une variable prédéfinie.$selected$ is a predefined variable. Elle représente le texte sélectionné dans l'éditeur XML avant l'appel de l'extrait.It represents the text that was selected in the XML Editor before invoking the snippet. La position de cette variable détermine l'emplacement du texte sélectionné dans l'extrait de code qui entoure cette sélection.The placement of this variable determines where the selected text appears in the code snippet that surrounds that selection.

  • $end$ est une variable prédéfinie.$end$ is a predefined variable. Lorsque l’utilisateur appuie sur entrée pour terminer la modification des champs d’extrait de code, cette variable détermine où le signe insertion (^) est déplacé.When the user presses Enter to finish editing the code snippet fields, this variable determines where the caret (^) is moved to.

    L'élément Code ci-dessus insère le texte XML suivant :The above Code element inserts the following XML text:

<test>
  <name>name</name>
</test>

La valeur de l'élément name est marquée comme une zone modifiable.The value of the name element is marked as an editable region.

Literal, élémentLiteral element

L'élément Literal permet d'identifier le texte de remplacement qui peut être personnalisé après son insertion dans le fichier.The Literal element is used to identify replacement text that can be customized after it is inserted into the file. Par exemple, des chaînes littérales, des valeurs numériques et certains noms de variables peuvent être déclarés comme littéraux.For example, literal strings, numeric values, and some variable names can be declared as literals. Vous pouvez définir un nombre quelconque de littéraux dans votre extrait XML et y faire référence plusieurs fois dans l'extrait.You can define any number of literals in your XML snippet and you can refer to them multiple times from within the snippet. L'exemple d'élément Literal suivant définit une variable $name$ dont la valeur par défaut est « name ».The following is an example of a Literal element that defines a $name$ variable whose default value is "name."

<Literal>
  <ID>name</ID>
  <Default>name</Default>
</Literal

Les littéraux peuvent également faire référence à des fonctions.Literals can also refer to functions. L’éditeur XML comprend une fonction nommée LookupPrefix.The XML Editor includes a function named LookupPrefix. Le LookupPrefix fonction recherche l’URI d’espace de noms donné à partir de l’emplacement dans le document XML de cet extrait est appelé et retourne le préfixe d’espace de noms qui est défini pour cet espace de noms, si un, et elle inclut les deux-points ( :)) Dans ce nom.The LookupPrefix function looks up the given namespace URI from the location in the XML document that this snippet is invoked from and returns the namespace prefix that is defined for that namespace, if any, and it includes the colon (:) in that name. Voici un exemple d’un Literal élément qui utilise le LookupPrefix (fonction).The following is an example of a Literal element that uses the LookupPrefix function.

<Literal Editable="false">
   <ID>prefix</ID>
   <Function>LookupPrefix("namespaceURI")</Function>
</Literal>

La variable $prefix$ _peut alors être utilisée ailleurs dans votre extrait XML.The $prefix$ variable can then be used elsewhere in your XML snippet.

Voir aussiSee also