Chaînes URL et jetons dans les compléments SharePoint

Important

Pour obtenir des informations générales sur la construction des URL dans SharePoint et sur l’utilisation des jetons dans ces URL, consultez l’article URL et jetons dans SharePoint. Cet article décrit les jetons disponibles dans les compléments SharePoint.

SharePoint prend en charge les jetons figurant dans les tableaux suivants pour une utilisation dans les compléments SharePoint.

Les jetons figurant dans les tableaux de cette section peuvent être utilisés dans les URL dans de nombreux contextes de développement des compléments SharePoint, par exemple dans les actions personnalisées et dans les liens présents sur les pages personnalisées.

Dans certains contextes, certains de ces jetons ne peuvent pas être utilisés. Trois des emplacements les plus importants où seule une liste restreinte de jetons peut être utilisée sont la page de démarrage d’un complément, une action personnalisée sur le site web hôte et la propriété Src d’un composant de complément. Elles sont appelées dans des colonnes distinctes, mais il ne s’agit pas d’une liste exhaustive des emplacements où les jetons peuvent être utilisés.

Dans chaque tableau :

  • La colonne StartPage indique si le jeton peut être utilisé dans l’élément StartPage d’un manifeste de complément.
  • La colonne Action personnalisée indique si le jeton peut être utilisé dans l’URL d’une action personnalisée sur un site web hôte.
  • La colonne Composant de complément indique si le jeton peut être utilisé dans la propriété Src du composant de complément.

Jetons pouvant être utilisés au début d’une URL

Jeton Résolu en StartPage Action personnalisée Composant de complément Remarques
~appWebUrl L'URL d'un site web de complément d'un Complément SharePoint. Oui Oui Oui Ce jeton ne doit être utilisé qu'à l'extérieur d'un site web de complément. Au sein du site web de complément, utilisez ~site pour l'URL du site web de complément.
~controlTemplates L'URL du dossier virtuel ControlTemplates pour le site web actuel. Non Non Non
~hostUrl URL du site Web hôte. Non Non Oui
~hostLogoUrl URL du logo du site Web hôte. Non Non Non
~layouts L'URL du dossier virtuel Dispositions pour le site web actuel. Non Non Non
~remoteAppUrl L'URL d'une application web à distance dans un Complément SharePoint. Oui Oui, dans le site web hôte. Non dans le site web de complément. Oui Si vous n'utilisez pas Outils de développement Microsoft Office pour Visual Studio pour développer votre complément SharePoint, vous ne pouvez pas utiliser ~remoteAppUrl dans l'URL StartPage. Cependant, si vous utilisez Visual Studio et les outils de développement, vous pouvez utiliser ce jeton pour les compléments hébergés par un fournisseur. Celui-ci est résolu lorsque Visual Studio crée le package du complément. Il s'agit dans ce cas plutôt d'un jeton Visual Studio que d'un jeton SharePoint. Il peut être utilisé en dehors du manifeste de complément même lorsque vous n'utilisez pas Outils de développement Microsoft Office pour Visual Studio.
~site L'URL du site web actuel. Non Non Oui
~sitecollection L'URL de la collection de sites parente du site web actuel. Non Non Oui

Sauf mention contraire, aucun des jetons figurant dans le tableau suivant ne peut être utilisé dans la partie chemin d'accès de la valeur de propriété Src du composant de complément. La colonne Composant de complément fait référence à l'utilisation des jetons dans la partie chaîne de requête de la valeur.


Jetons pouvant être utilisés au milieu d’une URL

Jeton Résolu en StartPage Action personnalisée Composant de complément Remarques
{AppContextToken} Jeton de contexte OAuth du complément. Non Non Non
{AppWebUrl} L'URL du site web de complément dans un Complément SharePoint. Oui Oui Oui Ce jeton doit être utilisé uniquement à l’extérieur d’un site web de complément.
À l’intérieur du site web de complément, indiquez le jeton {Site} au début de l’URL du site web de complément.
{ClientTag} Numéro de contrôle de cache client (balise cliente) du site Web actuel. Oui Oui Oui
{HostLogoUrl} Le logo du site web hôte d'un Complément SharePoint. Oui Oui Oui
{HostTitle} Le titre d'un site web hôte d'un Complément SharePoint. Oui Oui Oui
{HostUrl} L'URL du site web hôte d'un Complément SharePoint. Oui Oui Oui
{ItemId} ID d'un élément d'une liste ou d'une bibliothèque (un entier). Non Oui Non
{ItemUrl} L'URL de l'élément traité. Non Oui Non
{Language} La langue/culture actuelle du site web hôte d'un Complément SharePoint. Oui Oui Oui
{ListId} L'ID de la liste actuelle (GUID). Non Oui Non
{ProductNumber} Numéro de version de build complet de la batterie de serveurs SharePoint. Oui Oui Oui Exemple : « 15.0.4433.1011 ».
{RecurrenceId} L'index de périodicité d'un événement périodique. Non Oui Non Ce jeton n'est pas pris en charge dans les menus contextuels des éléments de liste.
{RemoteAppUrl} L'URL d'une application web à distance dans un Complément SharePoint. Oui Oui Oui
{Site} L'URL du site web actuel. Non Oui Oui
{SiteCollection} L'URL du site parent du site web actuel. Non Oui Oui
{SiteUrl} L'URL du site web actuel. Non Oui Non
{Source} URL de la requête HTTP. Non Oui Non
{StandardTokens} Voir les remarques. Oui Oui Oui Ce jeton combine cinq autres jetons. Il est initialement résolu en SPHostUrl={HostUrl}&SPAppWebUrl={AppWebUrl}&SPLanguage={Language}&SPClientTag={ClientTag}&SPProductNumber={ProductNumber}.

Ensuite, chacun de ces jetons est résolu. S’il n’y a pas de site web de complément, la partie &SPAppWebUrl={AppWebUrl} n’apparaît pas.

Voir aussi