SharePoint 加载项中的 URL 字符串和标记
重要
有关在 SharePoint 中构造 URL 和在这些 URL 中使用标记的常规信息，请参阅 SharePoint 中的 URL 和标记。 本主题介绍了 SharePoint 加载项中可用的标记。
SharePoint 支持在 SharePoint 加载项中使用下表中列出的标记。
在 SharePoint 加载项开发的各种不同情景下（例如在自定义操作中和自定义页面上的链接中），可在 URL 中使用本节表格中的标记。
在某些上下文中，部分标记无法使用。 只可使用受限的标记列表的三个最重要的位置分别是：加载项的起始页、主机 Web 的自定义操作和加载项部件的 Src 属性。 这三个位置在单独的列中标注，但这三者不构成可以使用标记的位置的详尽列表。
在每个表中：
- StartPage 列指定是否可以在加载项清单的 StartPage 元素中使用此标记。
- 自定义操作列指定是否可以在主机 Web 自定义操作的 URL 中使用此标记。
- 加载项部件列指定是否可以在加载项部件的 Src 属性中使用此标记。
可在 URL 的开头使用的标记
| 标记 | 解析为 | StartPage | 自定义操作 | 外接程序部件 | 备注 |
|---|---|---|---|---|---|
| ~appWebUrl | SharePoint 外接程序的外接程序 Web 的 URL。 | 是 | 是 | 是 | 此标记应仅在外接程序 Web 的外部使用。 在外接程序 Web 本身中，请对外接程序 Web 的 URL 使用 ~site。 |
| ~controlTemplates | 当前网站的 ControlTemplates 虚拟文件夹的 URL。 | 否 | 否 | 否 | |
| ~hostUrl | 主机 Web 的 URL。 | 否 | 否 | 是 | |
| ~hostLogoUrl | 主机 Web 徽标的 URL。 | 否 | 否 | 否 | |
| ~layouts | 当前网站的 Layouts 虚拟文件夹的 URL。 | 否 | 否 | 否 | |
| ~remoteAppUrl | SharePoint 外接程序的远程 Web 应用程序的 URL。 | 是 | 在主机 Web 中为是，但在外接程序 Web 中为否。 | 是 | 如果您不使用 Visual Studio Microsoft Office 开发人员工具来开发 SharePoint 外接程序，您仅可以在 StartPage URL 中使用 ~remoteAppUrl。 但是，如果您使用 Visual Studio 和工具，您可以对任意提供程序托管的外接程序使用该标记，当 Visual Studio 打包该外接程序时，它将被解析。 在这种使用情况下，它实际上更像一个 Visual Studio 标记，而非 SharePoint 标记。 它可在外接程序清单外使用，即使您没有使用 Visual Studio Microsoft Office 开发人员工具。 |
| ~site | 当前网站的 URL。 | 否 | 否 | 是 | |
| ~sitecollection | 当前网站的父网站集的 URL。 | 否 | 否 | 是 |
除非另有说明，否则下一个表中的任何标记都不能用于外接程序部件的 Src 属性值的路径部分。 外接程序部件列是指这些标记在该值的查询字符串部分的使用。
可在 URL 中使用的标记
| 标记 | 解析为 | StartPage | 自定义操作 | 外接程序部件 | 备注 |
|---|---|---|---|---|---|
| {AppContextToken} | 外接程序的 OAuth 上下文标记。 | 否 | 否 | 否 | |
| {AppWebUrl} | SharePoint 外接程序的外接程序 Web 的 URL。 | 是 | 是 | 是 | 此标记只能在加载项 Web 之外使用。 在加载项 Web 内，请为加载项 Web 的 URL 使用 {Site}。 |
| {ClientTag} | 当前网站的客户端缓存控制编号（客户端标记）。 | 是 | 是 | 是 | |
| {HostLogoUrl} | SharePoint 外接程序的主机 Web 的徽标。 | 是 | 是 | 是 | |
| {HostTitle} | SharePoint 外接程序的主机 Web 的标题。 | 是 | 是 | 是 | |
| {HostUrl} | SharePoint 外接程序的主机 Web 的 URL。 | 是 | 是 | 是 | |
| {ItemId} | 列表或库中的项目的 ID（整数）。 | 否 | 是 | 否 | |
| {ItemUrl} | 正在处理的项的 URL。 | 否 | 是 | 否 | |
| {Language} | SharePoint 外接程序的主机 Web 的当前语言/区域性。 | 是 | 是 | 是 | |
| {ListId} | 当前列表的 ID（一个 GUID）。 | 否 | 是 | 否 | |
| {ProductNumber} | SharePoint 服务器场的完整构造版本编号。 | 是 | 是 | 是 | 示例值为"15.0.4433.1011"。 |
| {RecurrenceId} | 定期事件的定期索引。 | 否 | 是 | 否 | 不支持将该标记用于列表项的上下文菜单中。 |
| {RemoteAppUrl} | SharePoint 外接程序的远程 Web 应用程序的 URL。 | 是 | 是 | 是 | |
| {Site} | 当前网站的 URL。 | 否 | 是 | 是 | |
| {SiteCollection} | 当前网站的父网站的 URL。 | 否 | 是 | 是 | |
| {SiteUrl} | 当前网站的 URL。 | 否 | 是 | 否 | |
| {Source} | HTTP 请求 URL。 | 否 | 是 | 否 | |
| {StandardTokens} | 请参阅注解。 | 是 | 是 | 是 | 此标记组合了五个其他标记。 它最初解析为... SPHostUrl={HostUrl}&SPAppWebUrl={AppWebUrl}&SPLanguage={Language}&SPClientTag={ClientTag}&SPProductNumber={ProductNumber} ...然后解析其中的每一个标记。 如果没有加载项 Web，则不显示 &SPAppWebUrl={AppWebUrl} 部分。 |