Paramètres de modèleTemplate parameters

Vous pouvez remplacer des valeurs dans votre modèle quand ce dernier est instancié.You can replace values in your template when the template is instantiated. Pour configurer cette fonctionnalité, utilisez des paramètres de modèle.To set up this functionality, use template parameters. 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.Template parameters can be used to replace values such as class names and namespaces in the template. 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.The template wizard that runs in the background when a user adds a new item or project replaces these parameters.

Déclaration et activation des paramètres de modèleDeclaring and enabling template parameters

Les paramètres de modèle sont déclarés au format $paramètre$.Template parameters are declared in the format $parameter$. Exemple :For example:

  • $safeprojectname$$safeprojectname$

  • $guid1$$guid1$

  • $guid5$$guid5$

Pour activer la substitution des paramètres dans les modèlesTo enable parameter substitution in templates

  1. 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.In the .vstemplate file of the template, locate the ProjectItem element that corresponds to the item for which you want to enable parameter replacement.

  2. Affectez à l'attribut ReplaceParameters de l'élément ProjectItem la valeur true.Set the ReplaceParameters attribute of the ProjectItem element to true.

  3. Dans le fichier de code de l’élément de projet, ajoutez les paramètres quand cela est approprié.In the code file for the project item, include parameters where appropriate. Par exemple, le paramètre suivant spécifie que le nom du projet sécurisé est utilisé pour désigner l’espace de noms dans un fichier :For example, the following parameter specifies that the safe project name is used for the namespace in a file:

    namespace $safeprojectname$
    

Paramètres de modèle réservésReserved template parameters

Le tableau suivant liste les paramètres de modèle réservés qui peuvent être utilisés par n’importe quel modèle.The following table lists the reserved template parameters that can be used by any template.

ParamètreParameter DescriptionDescription
clrversionclrversion Version actuelle du Common Language Runtime (CLR).Current version of the common language runtime (CLR).
guid[1-10]guid[1-10] GUID utilisé pour remplacer le GUID du projet dans un fichier projet.A GUID used to replace the project GUID in a project file. Vous pouvez spécifier jusqu’à 10 GUID uniques (par exemple, guid1).You can specify up to 10 unique GUIDs (for example, guid1).
itemnameitemname Nom fourni par l’utilisateur dans la boîte de dialogue Ajouter un nouvel élément.The name provided by the user in the Add New Item dialog box.
machinenamemachinename Nom de l’ordinateur actuel (par exemple, Ordi01).The current computer name (for example, Computer01).
projectnameprojectname Nom fourni par l’utilisateur dans la boîte de dialogue Nouveau projet.The name provided by the user in the New Project dialog box.
registeredorganizationregisteredorganization Valeur de clé de Registre provenant de HKLM\Software\Microsoft\Windows NT\CurrentVersion\RegisteredOrganization.The registry key value from HKLM\Software\Microsoft\Windows NT\CurrentVersion\RegisteredOrganization.
rootnamespacerootnamespace Espace de noms racine du projet actuel.The root namespace of the current project. Ce paramètre s’applique uniquement aux modèles d’élément.This parameter applies only to item templates.
safeitemnamesafeitemname 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.The name provided by the user in the Add New Item dialog box, with all unsafe characters and spaces removed.
safeprojectnamesafeprojectname 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.The name provided by the user in the New Project dialog box, with all unsafe characters and spaces removed.
heuretime Date et heure actuelles au format JJ/MM/AAAA 00:00:00.The current time in the format DD/MM/YYYY 00:00:00.
SpecificSolutionNameSpecificSolutionName Nom du fichier solution.The name of the solution. Quand l’option "créer le répertoire de la solution" est cochée, SpecificSolutionName porte le nom de la solution.When "create solution directory" is checked, SpecificSolutionName has the solution name. Quand l’option "créer le répertoire de solution" n’est pas cochée, SpecificSolutionName est vide.When "create solution directory" is not checked, SpecificSolutionName is blank.
userdomainuserdomain Domaine de l’utilisateur actuel.The current user domain.
Nom d’utilisateurusername Nom de l’utilisateur actuel.The current user name.
webnamespacewebnamespace Nom du site web actuel.The name of the current website. Ce paramètre est utilisé dans le modèle de formulaire web pour garantir des noms de classes uniques.This parameter is used in the web form template to guarantee unique class names. 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.If the website is at the root directory of the web server, this template parameter resolves to the root directory of the web server.
annéeyear Année actuelle au format AAAA.The current year in the format YYYY.

Note

Les paramètres de modèle respectent la casse.Template parameters are case-sensitive.

Paramètres de modèle personnalisésCustom template parameters

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.You can specify your own template parameters and values, in addition to the default reserved template parameters that are used during parameter replacement. Pour plus d’informations, consultez CustomParameters, élément (modèles Visual Studio).For more information, see CustomParameters element (Visual Studio templates).

Exemple : utilisation du nom du projet comme nom de fichierExample: Use the project name for a file name

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.You can specify variable file names for project items by using a parameter in the TargetFileName attribute.

L’exemple suivant spécifie que le nom d’un fichier exécutable utilise le nom du projet, spécifié par $projectname$.The following example specifies that an executable file's name uses the project name, specified by $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 nomsExample: Use the safe project name for the namespace name

Pour utiliser le nom du projet sécurisé pour l’espace de noms dans un fichier de classe C#, utilisez la syntaxe suivante :To use the safe project name for the namespace in a C# class file, use the following syntax:

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 :In the .vstemplate file for the project template, include the ReplaceParameters="true" attribute when you reference the file:

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

Voir aussiSee also