Parâmetros substituíveis
Os parâmetros substituível, ou os tokens, podem ser usados nos arquivos de projeto para fornecer valores para os itens de solução do SharePoint cujos valores reais não são conhecidos em tempo de design.Em a função são semelhantes aos tokens padrão do modelo de Visual Studio . Para obter mais informações, consulte Parâmetros de modelo.
formato simbólico
Os tokens começam e terminam com um caractere de cifrão ($).Todos os tokens usados são substituídos com os valores reais quando um projeto é empacotado em um arquivo de pacote de solução do SharePoint .wsp () no tempo de implantação.Por exemplo, o símbolo $SharePoint.Package.Name$ pode resolver a cadeia de caracteres de “pacote do SharePoint teste.”
regras simbólicas
As seguintes regras se aplicam aos tokens:
os tokens podem ser especificados em qualquer lugar em uma linha.
Os tokens não podem abranger várias linhas.
O mesmo token pode ser especificado várias vezes na mesma linha e no mesmo arquivo.
Símbolos diferentes podem ser especificados na mesma linha.
Os tokens que não seguem as regras são ignorados sem fornecer um aviso ou um erro.
A substituição de símbolos por valores de cadeia de caracteres é feita imediatamente após a transformação de manifesto, permitindo assim os modelos manifestos editados por um usuário para usar tokens.
Resolução de nome simbólico
Em a maioria dos casos, um token resolve a um valor específico independentemente de onde está contido.Em o entanto, se o símbolo está relacionado a um pacote ou a um recurso, o valor do símbolo depende de onde está contido.Por exemplo, se um recurso no é o pacote como, então $SharePoint.Package.Name$ simbólico resolve para o valor “A” pacote. se o mesmo recurso está no conjunto B, então às resoluções de $SharePoint.Package.Name$ para empacotar o “B”.
Lista de símbolos
A tabela a seguir lista os tokens disponíveis.
Nome |
Descrição |
---|---|
$SharePoint.Project.FileName$ |
O nome do arquivo de projeto recipiente, como, “NewProj.csproj”. |
$SharePoint.Project.FileNameWithoutExtension$ |
O nome do arquivo de projeto que contém sem a extensão de nome de arquivo.por exemplo, “NewProj”. |
$SharePoint.Project.AssemblyFullName$ |
O nome para exibição (assembly) de nome forte de saída do projeto que contém. |
$SharePoint.Project.AssemblyFileName$ |
O nome do conjunto de saída do projeto que contém. |
$SharePoint.Project.AssemblyFileNameWithoutExtension$ |
O nome do conjunto de saída do projeto que contém, sem a extensão de nome de arquivo. |
$SharePoint.Project.AssemblyPublicKeyToken$ |
O símbolo de chave pública do assembly de saída do projeto que contém, convertido em uma cadeia de caracteres.(16 characters no formato “x2” hexadecimal.) |
$SharePoint.Package.Name$ |
O nome do conjunto que contém. |
$SharePoint.Package.FileName$ |
O nome do arquivo de definição de pacote que contém. |
$SharePoint.Package.FileNameWithoutExtension$ |
O nome () sem extensão do arquivo de definição de pacote que contém. |
$SharePoint.Package.Id$ |
A identificação do SharePoint para o pacote que contém.Se um recurso é usado em mais de um pacote, então esse valor será alterado. |
$SharePoint.Feature.FileName$ |
O nome do arquivo de definição de recurso recipiente, como Feature1.feature. |
$SharePoint.Feature.FileNameWithoutExtension$ |
O nome do arquivo de definição de recurso, sem a extensão de nome de arquivo. |
$SharePoint.Feature.DeploymentPath$ |
O nome da pasta que contém o recurso no pacote.Este token é igual à propriedade de caminho implantação” no designer de recursos.Um valor de é exemplo, “Project1_Feature1”. |
$SharePoint.Feature.Id$ |
A identificação do SharePoint recurso recipiente.Este token, com todos os tokens de recurso nível, pode ser usado apenas os arquivos incluídos em um pacote através de um recurso, não adicionados diretamente a um pacote fora de um recurso. |
$SharePoint.ProjectItem.Name$ |
O nome do item de projeto (não seu nome de arquivo), como obtido de ISharePointProjectItem.Name. |
$SharePoint.Type.<GUID>.AssemblyQualifiedName$ |
O nome qualificado do assembly do tipo correspondente GUID o símbolo. O formato de GUID é minúsculo e corresponde ao formato de Guid.ToString (“D”) (isto é, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). |
$SharePoint.Type.<GUID>.FullName$ |
O nome completo do tipo correspondente no símbolo.O formato de GUID é minúsculo e corresponde ao formato de Guid.ToString (“D”) (isto é, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). |
Adicionando extensões a lista de token de extensões de Arquivo de substituição
Embora os tokens teoricamente possam ser usados por qualquer arquivo que pertencer a um item de projeto do SharePoint incluído no pacote, por padrão, pesquisas de Visual Studio para tokens somente em arquivos de pacote, arquivos de manifesto, e arquivos que têm as seguintes extensões:
XML
ASCX
ASPX
Webpart
DWP
Essas extensões são definidas pelo elemento <TokenReplacementFileExtensions> no arquivo Microsoft.VisualStudio.SharePoint.targets, localizado na pasta …\<program files>\MSBuild\Microsoft\VisualStudio\v11.0\SharePointTools.
Você pode, no entanto, adicione extensões de arquivos adicionais à lista.Para fazer isso, adicione um elemento de <TokenReplacementFileExtensions> a qualquer PropertyGroup no arquivo de projeto do SharePoint que é definida antes de <Import> do arquivo de destino do SharePoint.
Observação |
---|
Porque a substituição de token ocorre após um projeto é compilado, você não deve adicionar as extensões de arquivo para os tipos de arquivo que são compilados, como, .vb ou .cs .resx.Os tokens são substituídos somente em arquivos que não são compilados. |
Por exemplo, para adicionar as extensões de nome de arquivo “.myextension” e “.yourextension” na lista de extensões de nome de arquivo simbólicas de substituição, adicione o seguinte a um arquivo .csproj:
<Project ToolsVersion="4.0" DefaultTargets="Build" xmlns="https://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>
Como alternativa, você pode adicionar a extensão .targets diretamente para o arquivo.Em o entanto, isso altera as extensões lista para todos os projetos do SharePoint compactados no sistema local, não apenas o seu próprio.Isso pode ser conveniente quando você é o único desenvolvedor no sistema ou se a maioria dos seus projetos exigem.Entretanto, porque é específica do sistema, essa abordagem não é muito portátil e, portanto, é recomendável que você adiciona todas as extensões para o arquivo de projeto em vez de isso.