Paramètres remplaçablesReplaceable parameters

Paramètres remplaçables, ou jetons, peut être utilisé à l’intérieur des fichiers projet pour fournir des valeurs pour les éléments de solution SharePoint dont les valeurs réelles ne sont pas connues au moment du design.Replaceable parameters, or tokens, can be used inside project files to provide values for SharePoint solution items whose actual values aren't known at design time. Ils sont similaires à celui de la norme Visual StudioVisual Studio jetons de modèle.They're similar in function to the standard Visual StudioVisual Studio template tokens. Pour plus d’informations, consultez paramètres de modèle.For more information, see Template Parameters.

Format de jetonToken format

Les jetons commenceront et se terminent par un caractère de signe dollar ($).Tokens begin and end with a dollar sign ($) character. Sur le déploiement, les jetons employés sont remplacés par les valeurs réelles lorsqu’un projet est empaqueté dans un package de solution SharePoint (.wsp fichier).On deployment, any tokens used are replaced with actual values when a project is packaged into a SharePoint solution package (.wsp file). Par exemple, le jeton $SharePoint.Package.Name$ susceptibles de résoudre vers la chaîne « Test du Package SharePoint ».For example, the token $SharePoint.Package.Name$ might resolve to the string "Test SharePoint Package".

Règles de jetonToken rules

Les règles suivantes s’appliquent aux jetons :The following rules apply to tokens:

  • Les jetons peuvent être spécifiées n’importe où dans une ligne.Tokens can be specified anywhere in a line.

  • Les jetons ne peuvent pas couvrir plusieurs lignes.Tokens cannot span multiple lines.

  • Le même jeton peut être spécifié plusieurs fois sur la même ligne et dans le même fichier.The same token may be specified more than once on the same line and in the same file.

  • Jetons différents peuvent être spécifiés sur la même ligne.Different tokens may be specified on the same line.

    Les jetons qui ne suivent pas ces règles sont ignorées et n’entraînent pas un avertissement ou une erreur.Tokens that do not follow these rules are ignored and do not result in a warning or error.

    Le remplacement des jetons par des valeurs de chaîne est effectué immédiatement après la transformation du manifeste.The replacement of tokens by string values is done immediately after manifest transformation. Ce remplacement permet à l’utilisateur de modifier les modèles de manifeste avec des jetons.This replacement allows the user to edit the manifest templates with tokens.

Résolution de noms de jetonToken name resolution

Dans la plupart des cas, un jeton est résolu en une valeur spécifique, quel que soit l’endroit où elle est contenue.In most cases, a token resolves to a specific value regardless of where it is contained. Toutefois, si le jeton est lié à un package ou une fonctionnalité, sa valeur dépend dans lequel il est contenu.However, if the token is related to a package or feature, the token's value depends on where it is contained. Par exemple, si une fonctionnalité est dans un Package un, le jeton $SharePoint.Package.Name$ correspond à la valeur « Package A. »For example, if a feature is in Package A, then the token $SharePoint.Package.Name$ resolves to the value "Package A." Si la même fonctionnalité figure dans le Package B, $SharePoint.Package.Name$ correspond à « Package b ».If the same feature is in Package B, then $SharePoint.Package.Name$ resolves to "Package B."

Liste des jetonsTokens list

Le tableau suivant répertorie les jetons disponibles.The following table lists the available tokens.

NameName DescriptionDescription
$SharePoint.Project.FileName$$SharePoint.Project.FileName$ Le nom du conteneur de projet fichier, tel que NouvProj.csproj.The name of the containing project file, such as, NewProj.csproj.
$SharePoint.Project.FileNameWithoutExtension$$SharePoint.Project.FileNameWithoutExtension$ Le nom du fichier projet contenant sans l’extension de nom de fichier.The name of the containing project file without the file name extension. Par exemple, « NewProj ».For example, "NewProj".
$SharePoint.Project.AssemblyFullName$$SharePoint.Project.AssemblyFullName$ Le nom complet (nom fort) du projet contenant l’assembly de sortie.The display name (strong name) of the containing project's output assembly.
$SharePoint.Project.AssemblyFileName$$SharePoint.Project.AssemblyFileName$ Le nom du projet contenant l’assembly de sortie.The name of the containing project's output assembly.
$SharePoint.Project.AssemblyFileNameWithoutExtension$$SharePoint.Project.AssemblyFileNameWithoutExtension$ Le nom du projet conteneur de sortie d’assembly, sans l’extension de nom de fichier.The name of the containing project's output assembly, without the file name extension.
$SharePoint.Project.AssemblyPublicKeyToken$$SharePoint.Project.AssemblyPublicKeyToken$ Le jeton de clé publique du projet contenant de sortie d’assembly, converti en une chaîne.The public key token of the containing project's output assembly, converted to a string. (16 caractères au « x2 » format hexadécimal.)(16-characters in "x2" hexadecimal format.)
$SharePoint.Package.Name$$SharePoint.Package.Name$ Le nom du package qui le contient.The name of the containing package.
$SharePoint.Package.FileName$$SharePoint.Package.FileName$ Le nom de fichier de définition du package qui le contient.The name of the containing package's definition file.
$SharePoint.Package.FileNameWithoutExtension$$SharePoint.Package.FileNameWithoutExtension$ Le nom (sans extension) du fichier de définition du package qui le contient.The name (without extension) of the containing package's definition file.
$SharePoint.Package.Id$$SharePoint.Package.Id$ L’ID de SharePoint pour le package qui le contient.The SharePoint ID for the containing package. Si une fonctionnalité est utilisée dans plusieurs packages, cette valeur se modifie.If a feature is used in more than one package, then this value will change.
$SharePoint.Feature.FileName$$SharePoint.Feature.FileName$ Le nom du fichier de définition du contenant des fonctionnalités, telles que Feature1.feature.The name of the definition file of the containing feature, such as Feature1.feature.
$SharePoint.Feature.FileNameWithoutExtension$$SharePoint.Feature.FileNameWithoutExtension$ Le nom du fichier de définition de fonction, sans l’extension de nom de fichier.The name of the feature definition file, without the file name extension.
$SharePoint.Feature.DeploymentPath$$SharePoint.Feature.DeploymentPath$ Le nom du dossier qui contient la fonctionnalité dans le package.The name of the folder that contains the feature in the package. Ce jeton équivaut à la propriété « Chemin de déploiement » dans le Concepteur de fonctionnalités.This token equates to the "Deployment Path" property in the Feature Designer. Un exemple de valeur « Projet1_Fonctionnalite1 ».An example value is, "Project1_Feature1".
$SharePoint.Feature.Id$$SharePoint.Feature.Id$ L’ID SharePoint de la fonctionnalité de conteneur.The SharePoint ID of the containing feature. Ce jeton, comme avec tous les jetons de niveau de fonctionnalité, peut être utilisée uniquement par les fichiers inclus dans un package via une fonctionnalité, pas ajouté directement à un package en dehors d’une fonctionnalité.This token, as with all feature-level tokens, can be used only by files included in a package via a feature, not added directly to a package outside of a feature.
$SharePoint.ProjectItem.Name$$SharePoint.ProjectItem.Name$ Le nom de l’élément de projet (et non son nom de fichier), comme obtenu à partir de ISharePointProjectItem.Name.The name of the project item (not its file name), as obtained from ISharePointProjectItem.Name.
$SharePoint.Type. <GUID >. AssemblyQualifiedName$$SharePoint.Type.<GUID>.AssemblyQualifiedName$ Le nom qualifié assembly du type qui correspond le GUIDGUID du jeton.The assembly qualified name of the type matching the GUIDGUID of the token. Le format de la GUIDGUID est en minuscules et correspond au format GUID.ToString (autrement dit, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).The format of the GUIDGUID is lowercase and corresponds to the Guid.ToString("D") format (that is, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).
$SharePoint.Type. <GUID >. FullName$$SharePoint.Type.<GUID>.FullName$ Le nom complet du type correspondant au GUID dans le jeton.The full name of the type matching the GUID in the token. Le format du GUID est en minuscule et correspond au format GUID.ToString (autrement dit, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).The format of the GUID is lowercase and corresponds to the Guid.ToString("D") format (that is, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

Ajouter des extensions à la liste d’extensions de fichier remplacement des jetonsAdd extensions to the token replacement file extensions list

Bien que les jetons peuvent théoriquement être utilisés par n’importe quel fichier qui appartient à un projet SharePoint élément inclus dans le package, par défaut, Visual StudioVisual Studio recherche les jetons uniquement dans les fichiers de package, les fichiers manifestes et les fichiers ayant les extensions suivantes :Although tokens can theoretically be used by any file that belongs to a SharePoint project item included in the package, by default, Visual StudioVisual Studio searches for tokens only in package files, manifest files, and files that have the following extensions:

  • XMLXML

  • ASCXASCX

  • ASPXASPX

  • Composant WebPartWebpart

  • DWPDWP

    Ces extensions sont définies par le <TokenReplacementFileExtensions> élément dans le fichier Microsoft.VisualStudio.SharePoint.targets, situé dans le... \< fichiers programme>\MSBuild\Microsoft\VisualStudio\v11.0\SharePointTools dossier.These extensions are defined by the <TokenReplacementFileExtensions> element in the Microsoft.VisualStudio.SharePoint.targets file, located in the ...\<program files>\MSBuild\Microsoft\VisualStudio\v11.0\SharePointTools folder.

    Vous pouvez, toutefois, ajouter des extensions de fichiers supplémentaires à la liste.You can, however, add additional file extensions to the list. Ajouter un <TokenReplacementFileExtensions> élément à n’importe quel élément PropertyGroup dans le fichier de projet SharePoint qui est défini avant le <importation > du fichier de cibles SharePoint.Add a <TokenReplacementFileExtensions> element to any PropertyGroup in the SharePoint project file that is defined before the <Import> of the SharePoint targets file.

Note

Étant donné que le remplacement des jetons se produit après la compilation d’un projet, n’ajoutez pas les extensions de fichier pour les types de fichiers qui sont compilés, tels que .cs, .vb ou .resx.Because token replacement occurs after a project is compiled, you should not add file extensions for file types that are compiled, such as .cs, .vb or .resx. Les jetons sont remplacés uniquement dans les fichiers qui ne sont pas compilées.Tokens are replaced only in files that are not compiled.

Par exemple, pour ajouter les extensions de nom de fichier (.myextension et .yourextension) à la liste des extensions de nom de fichier de remplacement des jetons, vous devez ajouter le code suivant à un projet (.csproj ) fichier :For example, to add the file name extensions (.myextension and .yourextension) to the list of token replacement file name extensions, you would add the following to a project (.csproj) file:

<Project ToolsVersion="4.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">  
  <PropertyGroup>  
    <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>  
    <Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>  
.  
.  
.  
    <!-- Define the following property to add your extension to the list of token replacement file extensions.  -->  
<TokenReplacementFileExtensions>myextension;yourextension</TokenReplacementFileExtensions>  
</PropertyGroup>  

Vous pouvez ajouter l’extension directement vers les cibles (.targets) fichier.You can add the extension directly to the targets (.targets) file. Toutefois, ajoutez l’extension modifie la liste des extensions pour tous les projets SharePoint empaquetés sur le système local, non seulement vos propres.However, adding the extension alters the extensions list for all SharePoint projects packaged on the local system, not just your own. Cette extension peut être pratique lorsque vous êtes le seul développeur sur le système ou si la plupart de vos projets en avez besoin.This extension may be convenient when you are the sole developer on the system or if most of your projects require it. Cependant, car il est spécifique au système, cette approche n’est pas portable, et par conséquent, il est recommandé que vous ajoutez toutes les extensions au fichier projet à la place.However, because it is system-specific, this approach is not portable, and therefore, it is recommended that you add any extensions to the project file instead.

Voir aussiSee also

Développer des solutions SharePointDevelop SharePoint solutions