Tokens e cadeias de caracteres de URL em Suplementos do SharePoint
Importante
Para saber mais sobre como criar URLs no SharePoint e o uso de tokens nessas URLs, confira URLs e tokens no SharePoint. Este tópico descreve os tokens disponíveis nos Suplementos do SharePoint.
O SharePoint oferece suporte aos tokens listados nas tabelas a seguir para uso nos Suplementos do SharePoint.
Os tokens nas tabelas desta seção podem ser usados em URLs em uma ampla variedade de situações no desenvolvimento de Suplementos do SharePoint, como em Ações Personalizadas e em links em páginas personalizadas.
Em alguns contextos, alguns desses tokens não poderão ser usados. Três dos lugares mais importantes onde apenas uma lista restrita de tokens pode ser usada são a página inicial de um suplemento, uma ação personalizada no host da web e a propriedade Src de uma parte de suplemento. Eles são mostrados em colunas separadas, mas esta não é uma lista exaustiva de locais onde os tokens podem ser usados.
Em cada tabela:
- A coluna StartPage especifica se o token pode ser usado no elemento StartPage de um manifesto de suplemento.
- A coluna Ação Personalizada especifica se o token pode ser usado na URL de uma ação personalizada em um host da web.
- A coluna Parte de Suplemento especifica se o token pode ser usado na propriedade Src da parte de suplemento.
Os tokens que você pode usar no início de uma URL
| Token | Resolvido como | StartPage | Ação personalizada | Parte do suplemento | Comentários |
|---|---|---|---|---|---|
| ~appWebUrl | A URL do suplemento da Web de um Suplemento do SharePoint. | Sim | Sim | Sim | Esse token só deverá ser usado fora de uma web de suplemento. Dentro da própria web de suplemento, use ~site para a URL da web de suplemento. |
| ~controlTemplates | A URL da pasta virtual ControlTemplates para o site atual. | Não | Não | Não | |
| ~hostUrl | A URL do host da Web. | Não | Não | Sim | |
| ~hostLogoUrl | A URL do logotipo do host da Web. | Não | Não | Não | |
| ~layouts | A URL da pasta virtual Layouts para o site atual. | Não | Não | Não | |
| ~remoteAppUrl | A URL de um aplicativo Web remoto em um Suplemento do SharePoint. | Sim | Sim, no host da Web, mas Não no suplemento da Web. | Sim | Se não estiver usando o Microsoft Office Developer Tools para Visual Studio para desenvolver seu Suplemento do SharePoint, você não poderá usar ~remoteAppUrl na URL StartPage. No entanto, quando estiver usando o Visual Studio e as ferramentas, você poderá usar esse token para qualquer suplemento hospedado por provedor e ele será resolvido quando o Visual Studio empacotar o suplemento. Nesse caso, ele será muito mais um token do Visual Studio do que um token do SharePoint. Ele pode ser usado fora do manifesto do suplemento, mesmo quando você não estiver usando o Microsoft Office Developer Tools para Visual Studio. |
| ~site | A URL do site atual. | Não | Não | Sim | |
| ~sitecollection | A URL do conjunto de sites pai do site atual. | Não | Não | Sim |
Exceto quando indicado caso contrário, nenhum dos tokens na próxima tabela pode ser usado na parte de caminho do valor da propriedade Src da parte de suplemento. A coluna Parte de Suplemento refere-se ao seu uso na parte da cadeia de caracteres de consulta do valor.
Os tokens que você pode usar dentro de uma URL
| Token | Resolvido como | StartPage | Ação personalizada | Parte do suplemento | Comentários |
|---|---|---|---|---|---|
| {AppContextToken} | O token de contexto do OAuth para o suplemento. | Não | Não | Não | |
| {AppWebUrl} | A URL do suplemento da Web em um Suplemento do SharePoint. | Sim | Sim | Sim | Esse token só deverá ser usado fora de uma web de suplemento. Dentro da própria web de suplemento, use {Site} para a URL da web de suplemento. |
| {ClientTag} | O número de controle do cache do cliente (a marca de cliente) para o site atual. | Sim | Sim | Sim | |
| {HostLogoUrl} | O logotipo do host da Web de um Suplemento do SharePoint. | Sim | Sim | Sim | |
| {HostTitle} | O título do host da Web de um Suplemento do SharePoint. | Sim | Sim | Sim | |
| {HostUrl} | A URL do host da Web de um Suplemento do SharePoint. | Sim | Sim | Sim | |
| {ItemId} | A ID de um item em uma lista ou biblioteca (um inteiro). | Não | Sim | Não | |
| {ItemUrl} | A URL do item que está sendo tratado. | Não | Sim | Não | |
| {Language} | O idioma/cultura atual do host da Web de um Suplemento do SharePoint. | Sim | Sim | Sim | |
| {ListId} | A ID da lista atual (um GUID). | Não | Sim | Não | |
| {ProductNumber} | O número completo de versão da compilação do farm do SharePoint. | Sim | Sim | Sim | Um valor de exemplo é "15.0.4433.1011". |
| {RecurrenceId} | O índice de recorrência de um evento recorrente. | Não | Sim | Não | Não há suporte para esse token para uso em menus de contexto de itens de lista. |
| {RemoteAppUrl} | A URL de um aplicativo Web remoto em um Suplemento do SharePoint. | Sim | Sim | Sim | |
| {Site} | A URL do site atual. | Não | Sim | Sim | |
| {SiteCollection} | A URL do site pai do site atual. | Não | Sim | Sim | |
| {SiteUrl} | A URL do site atual. | Não | Sim | Não | |
| {Source} | A URL de solicitação HTTP. | Não | Sim | Não | |
| {StandardTokens} | Consulte os comentários. | Sim | Sim | Sim | Isso combina cinco outros tokens. É inicialmente resolvido como... SPHostUrl={HostUrl}&SPAppWebUrl={AppWebUrl}&SPLanguage={Language}&SPClientTag={ClientTag}&SPProductNumber={ProductNumber} ... Em seguida, cada um destes tokens será resolvido. Se não houver uma web de suplemento, a parte &SPAppWebUrl={AppWebUrl} não estará presente. |