Parâmetros substituíveis
Parâmetros substituíveis, ou tokens, pode ser usado dentro de arquivos de projeto para fornecer valores para os itens de solução do SharePoint cujos valores reais não são conhecidos no tempo de design. Eles são semelhantes em função para o padrão Visual Studio tokens de modelo. Para obter mais informações, consulte Parâmetros de modelo.
Formato de token
Tokens começam e terminam com um caractere de cifrão ($). Os tokens usados são substituídos por valores reais, quando um projeto é empacotado em um arquivo de pacote (. wsp) de solução do SharePoint no momento da implantação. Por exemplo, o token $SharePoint.Package.Name$ pode resolver para a seqüência de caracteres "teste SharePoint pacote".
Regras de token
As seguintes regras se aplicam aos tokens:
Tokens podem ser especificados em qualquer lugar em uma linha.
Símbolos não podem ocupar várias linhas.
O mesmo token pode ser especificado várias vezes na mesma linha e no mesmo arquivo.
Os tokens de diferentes podem ser especificados na mesma linha.
Os tokens que não seguem essas regras são ignorados sem fornecer um aviso ou erro.
A substituição de tokens de valores de seqüência de caracteres é feita imediatamente após a transformação de manifesto, permitindo assim que os modelos de manifesto editados por um usuário use tokens.
Resolução de nome de token
Na maioria dos casos, um token é resolvido para um valor específico, independentemente de onde ele está contido. No entanto, se o token é relacionado a um pacote ou recurso, o valor do token depende em que está contido. Por exemplo, se um recurso está no pacote token de um, em seguida, o $SharePoint.Package.Name$ resolve o valor "pacote a". Se o mesmo recurso está no pacote B, em seguida, $SharePoint.Package.Name$ resolve para um "pacote b".
Lista de tokens
A tabela a seguir lista os identificadores disponíveis.
Nome |
Descrição |
|---|---|
$SharePoint.Project.FileName$ |
O nome do arquivo de projeto contendo, como "NewProj.csproj". |
$SharePoint.Project.FileNameWithoutExtension$ |
O nome do arquivo do projeto contendo sem a extensão de nome de arquivo. Por exemplo, "newproj". |
$SharePoint.Project.AssemblyFullName$ |
O nome de exibição (nome de alta segurança) do projeto contendo saída do assembly. |
$SharePoint.Project.AssemblyFileName$ |
O nome do projeto contendo saída do assembly. |
$SharePoint.Project.AssemblyFileNameWithoutExtension$ |
O nome do projeto contendo saída do assembly, sem a extensão de nome de arquivo. |
$SharePoint.Project.AssemblyPublicKeyToken$ |
Assembly, convertido em uma seqüência de saída do token de chave pública do projeto contém. (16-caracteres em "x 2" formato hexadecimal.) |
$SharePoint.Package.Name$ |
O nome do pacote que o contém. |
$SharePoint.Package.FileName$ |
O nome do arquivo de definição do pacote que o contém. |
$SharePoint.Package.FileNameWithoutExtension$ |
O nome (sem extensão) do arquivo de definição do pacote que o contém. |
$SharePoint.Package.ID$ |
A identificação do SharePoint para o pacote que o contém. Se um recurso é usado em mais de um pacote, este valor será alterado. |
$SharePoint.Feature.FileName$ |
O nome do arquivo de definição do recurso contém, como, por exemplo, 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. Esse token equivale a "Caminho de implantação" propriedade no Designer de recurso. Um valor de exemplo é "project1_feature1". |
$SharePoint.Feature.ID$ |
A identificação do SharePoint do recurso que o contém. Esse token, como com todos os tokens de nível de recurso pode ser usado apenas por arquivos incluídos em um pacote por meio de um recurso não adicionado diretamente para um pacote fora de um recurso. |
$SharePoint.ProjectItem.Name$ |
O nome do item de projeto (não seu nome de arquivo), como obtidos de ISharePointProjectItem.Name. |
$SharePoint.Type. <GUID>.AssemblyQualifiedName$ |
O nome qualificado do assembly de correspondência de tipo de GUID do token. O formato do GUID é minúsculo e corresponde ao formato Guid.ToString("D") (ou seja, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). |
$SharePoint.Type. <GUID>.FullName$ |
O nome completo do tipo GUID no token de correspondência. O formato do GUID é minúsculo e corresponde ao formato Guid.ToString("D") (ou seja, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). |
Adicionar extensões à lista de extensões de arquivo de substituição de Token
Embora os tokens, teoricamente, podem ser usados por qualquer arquivo que pertença a um projeto do SharePoint item incluído no pacote, por padrão, Visual Studio procura 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 <TokenReplacementFileExtensions> o elemento no arquivo Microsoft.VisualStudio.SharePoint.targets, localizado na pasta de \MSBuild\Microsoft\VisualStudio\v10.0\SharePointTools do …\ os arquivos de programa < >.
No entanto, você pode adicionar extensões de arquivo adicionais à lista. Para fazer isso, adicione um <TokenReplacementFileExtensions> elemento para qualquer PropertyGroup no arquivo de projeto do SharePoint que está definido antes de <Import> do arquivo de destinos do SharePoint.
.gif "Observação") Observação |
|---|
Como token substituição ocorre depois que um projeto é compilado, você não deve adicionar extensões de arquivo para tipos de arquivo que são compilados, como, por exemplo,. cs,. vb ou. resx. Tokens são substituídos somente em arquivos não são compilados. |
Por exemplo, para adicionar as extensões de nome de arquivo ".myextension" e ".yourextension" a lista de extensões de nome de arquivo do token de substituição, você adicionaria o seguinte em 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 diretamente para o arquivo. targets. No entanto, isso altera a lista de extensões para todos os projetos do SharePoint, empacotados no sistema local, não apenas sua própria. Isso pode ser conveniente quando você tiver o desenvolvedor exclusivo no sistema ou se a maioria dos projetos requer que ele. No entanto, porque ele é específico do sistema, essa abordagem não é bastante portátil e, portanto, é recomendável que você adicionar quaisquer extensões para o arquivo de projeto em vez disso.