URL-Zeichenfolgen und Tokens in SharePoint-Add-Ins
Wichtig
Allgemeine Informationen zur Erstellung von URLs in SharePoint und zur Verwendung von Token in diesen URLs finden Sie unter URLs und Token in SharePoint. In diesem Thema werden die in SharePoint-Add-Ins verfügbaren Token beschrieben.
SharePoint unterstützt die in der folgenden Tabelle aufgeführten Token in SharePoint-Add-Ins.
Die Token in den Tabellen in diesem Abschnitt können URLs in eine Vielzahl von Situationen bei der Entwicklung von SharePoint-Add-Ins verwendet werden, z. B. in benutzerdefinierten Aktionen und Links auf benutzerdefinierten Seiten.
In bestimmten Kontexten können diese Token nicht verwendet werden. Drei der wichtigsten Orte, an denen nur eine eingeschränkte Liste von Token verwendet werden kann, ist die Startseite eines Add-Ins, eine benutzerdefinierte Aktion im Hostweb und die Src-Eigenschaft eines Add-In-Teils. Diese werden in separaten Spalten aufgerufen, , hierbei handelt es sich jedoch nicht um eine vollständige Liste der Konten, die verwendet werden können.
In jeder Tabelle:
- Die StartPage-Spalte gibt an, ob das Token in dem StartPage-Element eines Add-In-Manifests verwendet werden kann.
- Die Spalte Benutzerdefinierte Aktion gibt an, ob das Token in der URL einer benutzerdefinierten Aktion in einem Hostweb verwendet werden kann.
- Die Spalte Add-In-Teil gibt an, ob das Token in der Src-Eigenschaft eines Add-In-Manifests verwendet werden kann.
Token, die am Anfang einer URL verwendet werden können
Token | Wird aufgelöst zu | StartPage | Benutzerdefinierte Aktion | Add-In-Webpart | Bemerkungen |
---|---|---|---|---|---|
~appWebUrl | Die URL des Add-In-Webs einer SharePoint-Add-In. | Ja | Ja | Ja | Dieses Token sollte nur außerhalb von Add-In-Webs verwendet werden. Im Add-In-Web verwenden Sie ~site als URL des Add-In-Webs. |
~controlTemplates | Die URL des virtuellen Ordners ControlTemplates der aktuellen Website | Nein | Nein | Nein | |
~hostUrl | Die URL des Hostweb | Nein | Nein | Ja | |
~hostLogoUrl | Die URL des Logos des Hostweb | Nein | Nein | Nein | |
~layouts | Die URL des virtuellen Ordners Layouts für die aktuelle Website | Nein | Nein | Nein | |
~remoteAppUrl | Die URL einer Remotewebanwendung in einer SharePoint-Add-In. | Ja | "Ja" im Hostweb, aber "Nein" im Add-In-Webpart | Ja | Wenn Sie microsoft Office Developer Tools für Visual Studio nicht zum Entwickeln Ihres SharePoint-Add-Ins verwenden, können Sie ~remoteAppUrl nicht in der StartPage-URL verwenden. Wenn Sie jedoch Visual Studio und die Tools verwenden, können Sie dieses Token für jedes vom Anbieter gehostete Add-In verwenden, und es wird aufgelöst, wenn Visual Studio das Add-In packt. Bei dieser Verwendung handelt es sich tatsächlich eher um ein Visual Studio-Token als um ein SharePoint-Token. Es kann außerhalb des Add-In-Manifests verwendet werden, auch wenn Sie microsoft Office Developer Tools für Visual Studio nicht verwenden. |
~site | Die URL der aktuellen Website. | Nein | Nein | Ja | |
~sitecollection | Die URL der übergeordneten Websitesammlung der aktuellen Website. | Nein | Nein | Ja |
Sofern nicht anders angegeben, kann keines der Token in der nächsten Tabelle im Pfadteil des Src-Eigenschaftswerts des Add-In-Webparts verwendet werden. Die Spalte Add-In-Webpart bezieht sich auf deren Verwendung im Abfragezeichenfolge-Teil des Werts.
Token, die in einer URL verwendet werden können
Token | Wird aufgelöst zu | StartPage | Benutzerdefinierte Aktion | Add-In-Webpart | Bemerkungen |
---|---|---|---|---|---|
{AppContextToken} | Das OAuth-Kontexttoken für das Add-In | Nein | Nein | Nein | |
{AppWebUrl} | Die URL des Add-In-Webparts in einer SharePoint-Add-In | Ja | Ja | Ja | Dieses Token sollte nur außerhalb eines Add-In-Webs verwendet werden. Verwenden Sie in dem Add-In-Web selbst {Site} für die URL des Add-In-Webs. |
{ClientTag} | Die Clientcache-Kontrollnummer (Clienttag) für die aktuelle Website | Ja | Ja | Ja | |
{HostLogoUrl} | Das Logo für das Hostweb einer SharePoint-Add-In. | Ja | Ja | Ja | |
{HostTitle} | Der Titel des Hostwebs einer SharePoint-Add-In. | Ja | Ja | Ja | |
{HostUrl} | Die URL des Hostwebs einer SharePoint-Add-In. | Ja | Ja | Ja | |
{ItemId} | Die ID eines Elements in einer Liste oder Bibliothek (eine ganze Zahl) | Nein | Ja | Nein | |
{ItemUrl} | Die URL des Elements, an dem eine Aktion ausgeführt wird. | Nein | Ja | Nein | |
{Language} | Die aktuelle Sprach-/Kultureinstellung des Hostwebs einer SharePoint-Add-In. | Ja | Ja | Ja | |
{ListId} | Die ID der aktuellen Liste (eine GUID). | Nein | Ja | Nein | |
{ProductNumber} | Die vollständige Buildversionsnummer der SharePoint-Farm | Ja | Ja | Ja | Beispielwert: "15.0.4433.1011" |
{RecurrenceId} | Der Wiederholungsindex eines sich wiederholenden Ereignisses. | Nein | Ja | Nein | In Kontextmenüs von Listenelementen wird die Verwendung dieses Tokens nicht unterstützt. |
{RemoteAppUrl} | Die URL einer Remotewebanwendung in einer SharePoint-Add-In. | Ja | Ja | Ja | |
{Site} | Die URL der aktuellen Website. | Nein | Ja | Ja | |
{SiteCollection} | Die URL der übergeordneten Website der aktuellen Website. | Nein | Ja | Ja | |
{SiteUrl} | Die URL der aktuellen Website. | Nein | Ja | Nein | |
{Source} | Die URL der HTTP-Anforderung | Nein | Ja | Nein | |
{StandardTokens} | Weitere Informationen finden Sie in der "Anmerkungen". | Ja | Ja | Ja | Dadurch werden die fünf anderen Token kombiniert. Zunächst werden sie aufgelöst zu... SPHostUrl={HostUrl}&SPAppWebUrl={AppWebUrl}&SPLanguage={Language}&SPClientTag={ClientTag}&SPProductNumber={ProductNumber} ... und dann werden diese Token aufgelöst. Falls es kein Add-In-Web gibt, ist der Teil &SPAppWebUrl={AppWebUrl} nicht vorhanden. |