Création de templates dynamiques

De Appmethod Topics
Aller à : navigation, rechercher

Remonter à Comment modifier le code dans l'éditeur de code


Lorsque vous travaillez dans l'éditeur de code, vous pouvez ajouter vos constructions de code favorites au Gestionnaire de templates et créer une bibliothèque des templates que vous utilisez le plus souvent.

Pour ajouter un template dynamique

Démarrer un template de code dans l'éditeur de code

Dans l'éditeur de code, effectuez l'une des actions suivantes :

  • Choisissez Fichier > Nouveau > Autre > Autres fichiers et sélectionnez l'icône Template de code.
  • Choisissez Voir > Templates, puis cliquez sur le bouton Nouveau dans la fenêtre Templates, située à la position de la palette d'outils, dans le coin inférieur droit de l'EDI.

Vous pouvez aussi sélectionner du code dans l'éditeur avant de cliquer sur le bouton Nouveau ; le code sélectionné est placé à l'intérieur des crochets [] du champ <code><![CDATA[]]></code>.

Voici le code XML que l'EDI affiche quand vous démarrez un template dynamique :

 <?xml version="1.0" encoding="utf-8" ?>
 <codetemplate	xmlns="http://schemas.borland.com/Delphi/2005/codetemplates"
 				version="1.0.0">
 	<template '''name="|"''' invoke="manual"> 
 		<description>
 
 		</description>
 		<author>
 
 		</author>
 		<code language=""><![CDATA[]]>
 		</code>
 	</template>
 </codetemplate>

Quand vous ouvrez pour la première fois le squelette du template dynamique, le champ name=" " apparaît en surbrillance, et le curseur est situé entre les deux guillemets (name="|").

Remarque : Vous pouvez utiliser la palette d'outils pour ouvrir le squelette XML d'un template dynamique dans l'éditeur de code. Entrez template dans le champ de recherche de la palette d'outils, et appuyez sur Entrée ou double-cliquez sur Template de code.

Fournir les valeurs d'attributs dans le XML

Remplissez maintenant les champs du template ; vous pouvez ajouter des champs spécifiques qui sont nécessaires à votre template.

  1. Commencez par assigner un nom à votre template. Les champs template name et code language du template sont obligatoires.
  2. Dans le champ invoke, spécifiez la façon dont ce template sera invoqué :
    • manual - invoqué par l'appui sur la touche TAB
    • auto - invoqué par l'appui sur la touche ESPACE ou TAB
    • none - invoqué en utilisant CTRL+J, CTRL+ESPACE, ou la fenêtre Templates
  3. Remplissez la description, l'auteur et les attributs de langage de code (language="Object Pascal" ou language="C").

Définir les points de saut

Les points de saut sont des espaces réservés navigables et facultatifs pour les champs d'entrée. Si vous voulez que votre template contienne ces espaces réservés, vous devez alors définir un point pour chaque champ d'entrée dans le template. Quand quelqu'un utilise le template, il peut sauter d'un point à un autre en utilisant la touche Tab ou la barre Espace.

Pour définir des points de saut dans votre template :

  1. Positionnez le curseur (les points de saut sont typiquement les premiers éléments définis dans un template dynamique, et doivent donc être situés avant le champ <description>).
  2. Double-cliquez sur le template point, qui est disponible dans la fenêtre Templates quand vous créez un template dynamique.
Le template point est affiché à la position du curseur dans l'éditeur de code :

PointTemplateLive.png

Chaque point a trois valeurs d'attributs :

  • PointName définit le nom du point de saut.
  • PointText définit le texte descriptif affiché dans la fenêtre Templates. Dans l'éditeur de code, le point de saut affiche de façon erronée PointName, mais le XML réel du point est correct.
  • PointHint définit le conseil contextuel du point.

qui sont définis en tant que points de saut dans ce template. Pour chaque point, ces valeurs d'attributs définissent le nom, le texte (la description affichée dans la fenêtre Templates) et un conseil (qui s'affiche quand la souris passe au-dessus d'un template dans la fenêtre Templates.

Entrer le code et enregistrer le template

  1. Tapez le code de votre template, à l'intérieur des crochets imbriqués ([ ]) dans la balise <code><![CDATA[]]></code>.
    Par exemple, voici le XML du template point lui-même. point.xml contient trois points (PointName, PointText, PointHint) et vous pouvez voir la représentation du code du template point dans <code><![CDATA[]]></code> :
<?xml version="1.0" encoding="utf-8" ?>
<codetemplate	xmlns="http://schemas.borland.com/Delphi/2005/codetemplates"
				version="1.0.0">
    <template name="point" invoke="manual">
		 <description>
			Create a point in code templates
		 </description>
        <author>
			Embarcadero
		</author>
		 <point name="PointName">
			 <text>
				 PointName
			 </text>
			 <hint>
                 Name of the point
			 </hint>
		 </point>
		 <point name="PointText">
			 <text>
				 PointText
			 </text>
			 <hint>
			   Text for the point
			 </hint>
		 </point>
		 <point name="PointHint">
			 <text>
				 PointHint
			 </text>
			 <hint>
               Text for the point's hint
			 </hint>
		 </point>
		 <code language="XML" delimiter="|"><![CDATA['''<point name="|PointName|">
|*|<text>
|*||*||PointName|
|*|</text>
|*|<hint>
|*||*||PointHint|
|*|</hint>
</point>|end|''']]>
		 </code>
	</template>
</codetemplate>
2. Choisissez la commande Enregistrer dans le menu Fichier de l'éditeur de code (ou utilisez la combinaison de touches <code>CTRL + S</code>). Votre nouveau template apparaît désormais dans l'arborescence de la fenêtre Templates.
Les templates sont enregistrés par défaut dans le répertoire C:\Utilisateurs\<utilisateur>\Documents\Embarcadero\Studio\code_templates. Ils doivent être enregistrés dans ce répertoire afin d'apparaître dans la liste Templates de l'EDI.


Pour de plus amples informations sur les templates dynamiques, notamment les liens vers des procédures plus détaillées et des démos, voir http://delphi.wikia.com/wiki/Live_Templates_Technical_Info

Voir aussi