Paramètres de modèle

Article
05/23/2024

Vous pouvez remplacer des valeurs dans votre modèle quand ce dernier est instancié. Pour configurer cette fonctionnalité, utilisez des paramètres de modèle. Les paramètres de modèle peuvent être utilisés pour remplacer des valeurs, comme les noms de classes et les espaces de noms, dans le modèle. L’Assistant Modèle, qui s’exécute en arrière-plan quand un utilisateur ajoute un nouvel élément ou un nouveau projet, remplace ces paramètres.

Déclarer et activer des paramètres de modèle

Les paramètres de modèle sont déclarés au format $paramètre$. Par exemple :

$rootnamespace$
$guid1$
$guid5$

Activer la substitution des paramètres dans les modèles

Dans le fichier .vstemplate du modèle, localisez l’élément ProjectItem qui correspond à l’élément pour lequel vous souhaitez activer le remplacement des paramètres.
Affectez à l'attribut ReplaceParameters de l'élément ProjectItem la valeur true.
Dans le fichier de code de l’élément de projet, ajoutez les paramètres quand cela est approprié. Par exemple, le paramètre suivant spécifie que l’espace de noms racine est utilisé comme espace de noms dans un fichier :
```
namespace $rootnamespace$
```

Paramètres de modèle réservés

Le tableau suivant liste les paramètres de modèle réservés qui peuvent être utilisés par n’importe quel modèle :

Paramètre	Description
clrversion	Version actuelle du Common Language Runtime (CLR).
ext_*	Ajoutez le préfixe `ext_` à n’importe quel paramètre pour référencer les variables du modèle parent. Par exemple : `ext_safeprojectname`.
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	Le nom du fichier dans lequel le paramètre est utilisé.
machinename	Nom de l’ordinateur actuel (par exemple, Ordi01).
projectname	Nom fourni par l’utilisateur quand le projet a été créé. Ce paramètre s’applique uniquement aux modèles de projet.
registeredorganization	Valeur de clé de Registre provenant de HKLM\Software\Microsoft\Windows NT\CurrentVersion\RegisteredOrganization.
rootnamespace	Espace de noms racine du projet actuel suivi du sous-dossier de l’élément actif, les barres obliques étant remplacées par des points.
defaultnamespace	Espace de noms racine du projet actuel.
safeitemname	Identique à `itemname`, mais avec tous les caractères et espaces potentiellement dangereux remplacés par des caractères de trait de soulignement.
safeitemrootname	Comme pour `safeitemname`.
safeprojectname	Nom fourni par l’utilisateur quand le projet a été créé, dont tous les caractères et espaces potentiellement dangereux ont été supprimés. Ce paramètre s’applique uniquement aux modèles de projet.
targetframeworkversion	Version actuelle du .NET Framework cible.
time	Heure actuelle dans un format basé sur les paramètres utilisateur de Windows. Un exemple de format d’heure est JJ/MM/AAAA 00:00:00.
specifiedsolutionname	Nom du fichier solution. Lorsque « Placer la solution et le projet dans le même répertoire » n’est pas case activée ed, `specifiedsolutionname` a le nom de la solution. Quand l’option "créer le répertoire de solution" n’est pas cochée, `specifiedsolutionname` est vide.
userdomain	Domaine de l’utilisateur actuel.
username	Nom de l’utilisateur actuel.
webnamespace	Nom du site web actuel. Ce paramètre est utilisé dans le modèle de formulaire web pour garantir des noms de classes uniques. Si le site web se trouve dans le répertoire racine du serveur web, ce paramètre de modèle correspond à ce répertoire racine.
year	Année actuelle au format AAAA.

Notes

Les paramètres de modèle respectent la casse.

Paramètres de modèle personnalisés

Vous pouvez spécifier vos propres paramètres et valeurs de modèle, en plus des paramètres de modèle réservés par défaut utilisés lors du remplacement de paramètres. Pour plus d’informations, consultez CustomParameters, élément (modèles Visual Studio).

Exemple : utilisation du nom du projet comme nom de fichier

Vous pouvez spécifier des noms de fichiers de variables pour les éléments de projet à l’aide d’un paramètre dans l’attribut TargetFileName.

L’exemple suivant spécifie que le nom d’un fichier exécutable utilise 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 sécurisé comme nom de l’espace de noms

Pour utiliser le nom du projet sécurisé pour l’espace de noms dans un fichier de classe C#, utilisez la syntaxe suivante :

namespace $safeprojectname$
{
    public class Class1
    {
        public Class1()
        { }
    }
}

Dans le fichier .vstemplate du modèle de projet, ajoutez l’attribut ReplaceParameters="true" quand vous référencez le fichier :

<TemplateContent>
    <ProjectItem ReplaceParameters="true">
        Class1.cs
    </ProjectItem>
    ...
</TemplateContent>

Partager via