Paramètres de modèle
À l'aide de les paramètres dans vos modèles, vous pouvez remplacer les valeurs des principales parties du modèle, telles que les noms de classes et les espaces de noms, lorsque le modèle est instancié.Ces paramètres sont remplacés par l'Assistant de modèle qui s'exécute en arrière-plan lorsqu'un utilisateur clique sur OK dans les boîtes de dialogue Nouveau projet ou Ajouter un nouvel élément.
Déclaration et activation des paramètres d'un modèle
Les paramètres d'un modèle sont déclarés dans le format $paramètre$.Par exemple :
$nomprojetfiable$
$guid1$
$guid5$
Pour activer la substitution de paramètres dans les modèles
Dans le fichier .vstemplate du modèle, localisez l'élément d' ProjectItem qui correspond à l'élément pour lequel vous souhaitez activer le remplacement de paramètre.
Donnez à l'attribut ReplaceParameters de l'élément ProjectItem la valeur true.
Dans le fichier de code de l'élément de projet, incluez les paramètres aux emplacements appropriés.Par exemple, le paramètre suivant spécifie que nomprojetfiable sera utilisé pour désigner l'espace de noms dans un fichier :
namespace $safeprojectname$
Paramètres de modèle réservés
Le tableau suivant répertorie les paramètres de modèle réservés qui peuvent être utilisés dans tout modèle.
[!REMARQUE]
Les paramètres de modèle respectent la casse.
Paramètre |
Description |
---|---|
clrversion |
Version actuelle du Common Language Runtime (CLR). |
GUID [1-10] |
GUID utilisé pour remplacer le GUID du projet dans un fichier projet.Vous pouvez spécifier jusqu'à 10 GUID uniques (par exemple, guid1). |
itemname |
Nom fourni par l'utilisateur dans la boîte de dialogue Ajouter un nouvel élément. |
machinename |
Nom de l'ordinateur actuel (par exemple, Ordi01). |
projectname |
Nom fourni par l'utilisateur dans la boîte de dialogue Nouveau projet. |
registeredorganization |
Valeur de la clé de Registre tirée de HKLM\Software\Microsoft\Windows NT\CurrentVersion\RegisteredOrganization. |
rootnamespace |
Espace de noms racine du projet actuel.Ce paramètre s'applique uniquement aux modèles d'élément. |
safeitemname |
Nom fourni par l'utilisateur dans la boîte de dialogue Ajouter un nouvel élément, dont tous les caractères et espaces potentiellement dangereux ont été supprimés. |
safeprojectname |
Nom fourni par l'utilisateur dans la boîte de dialogue Nouveau projet, dont tous les caractères et espaces potentiellement dangereux ont été supprimés. |
time |
Date et heure actuelles au format JJ/MM/AAAA 00:00:00. |
SpecifiedSolutionName |
Le nom de la solution. |
userdomain |
Domaine d'utilisateur actuel. |
username |
Nom de l'utilisateur actuel. |
webnamespace |
Nom du site Web en cours.Ce paramètre est utilisé dans le modèle de formulaire Web pour garantir des noms de classe uniques.Si le site Web se situe dans le répertoire racine du serveur Web, ce paramètre de modèle se résout en répertoire racine du serveur Web. |
year |
Année actuelle au format AAAA. |
Paramètres des modèles personnalisés
Vous pouvez spécifier vos propres paramètres et valeurs de modèle, en plus de les paramètres réservés de modèle par défaut utilisés pendant le remplacement de paramètres. Pour plus d'informations, consultez CustomParameters, élément (modèles Visual Studio)
Exemple : Remplacement de noms de fichiers
Vous pouvez spécifier des noms de fichiers de variables pour les éléments de projet à l'aide d'un paramètre avec l'attribut TargetFileName.Par exemple, vous pourriez spécifier que le fichier .exe prendra comme nom le nom du projet, spécifié par $projectname$.
<TemplateContent>
<ProjectItem
ReplaceParameters="true"
TargetFileName="$projectname$.exe">
File1.exe
</ProjectItem>
...
</TemplateContent>
Exemple : Utilisation du nom du projet comme nom de l'espace de noms
Pour que le projet et l'espace de noms portent le même nom dans le fichier de classe Visual C# Class1.cs, utilisez la syntaxe suivante :
#region Using directives
using System;
using System.Collections.Generic;
using System.Text;
#endregion
namespace $safeprojectname$
{
public class Class1
{
public Class1()
{
}
}
}
Dans le fichier .vstemplate du modèle de projet, incluez le XML suivant lorsque vous référencez le fichier Class1.cs :
<TemplateContent>
<ProjectItem ReplaceParameters="true">
Class1.cs
</ProjectItem>
...
</TemplateContent>