SharePoint 2013 の URL とトークン
SharePoint で、URL を作成する方法と URL トークンを使用する方法について説明します。
SharePoint の URL の種類
SharePoint は URL 文字列を解析し、指定されたプロトコル (たとえば、 http:) または文字列内のスラッシュ (/) の位置に基づいて URL の形式を特定します。 個々のメンバに応じて、以下の URL の形式を使用できます。
絶対 URL は、最初にプロトコルを指定して、完全なパスを指定します。 たとえば、
http://domain_or_server/[sites/] Web_Site/Lists/ List_Title/AllItems.aspx。ドメイン相対 URL は、ドメイン (サーバーの名前の場合もある) アドレスを基準とし、常にスラッシュで始まります。 これは、最上位の Web サイトからファイル名までの完全なパスを指定します。 たとえば、/[
sites/] Web_Site/Lists/ List_Title/AllItems.aspxのようになります。Web サイト相対 URL は、Web サイト オブジェクト ( SPWeb ) のアドレスを基準とします。 これは、最初にスラッシュを 含めずに、Web サイト アドレスからファイル名までの完全なパスを指定します。 たとえば、
Lists/List_Title/AllItems.aspx。ファイルまたはフォルダーを基準とする URL は、ファイルを含むフォルダーに基づいています。 スラッシュは含まれません。 ファイルの名前を指定するだけです。 たとえば、「
AllItems.aspx」のように入力します。
注:
"サイト コレクション相対 URL" という考え方はありません。そのような URL を渡すと、コードが失敗する可能性があります。
画像 URL に関する推奨
%ProgramFiles%\Common Files\Microsoft Shared\Web サーバー拡張機能\15\TEMPLATE\LAYOUTS\1033\IMAGES ディレクトリにあるイメージ ファイルの URL を作成する場合は、サイト コレクションのルート Web サイトを使用するパスを指定しますが、パス内にサブサイトは含まれません。 たとえば、画像ファイルには、/MySubsite/_layouts/images/MyImage.gif ではなく、/_layouts/images/MyImage.gif を使用してください。 これは、サブサイト URL はそれが使用されている場所によって解決方法が異なるためです。 ルート Web サイト相対 URL を常に使用すれば、このような違いは無視されます。
SharePoint の URL トークン
SharePoint は、SharePoint アドイン またはファーム ソリューションにおいて以下の表に挙げられているトークンの使用をサポートします。 いくつかのトークンはアプリでのみ使用可能です。 詳細については、「 SharePoint アドインの URL 文字列とトークン」を参照してください。
このセクションの表に示されたトークンは、カスタム アクションやカスタム ページのリンクなど、SharePoint を開発する際のさまざまな状況の URL で使用できます。 場合によっては、これらのトークンの一部は使用できません。 制限付きトークンのリストのみを使用できる最も重要な場所の 3 つは、アプリのスタート ページ、ホスト Web 上のカスタム アクション、アプリ パーツの Src プロパティです。 これらについては別の列で説明されていますが、トークンを使用できるのはこれら 3 つの場所だけではありません。
" StartPage " 列では、アプリ マニフェストの StartPage 要素にトークンを使用できるかどうかを指定します。 " カスタム アクション " 列では、ホスト Web のカスタム アクションの URL にトークンを使用できるかどうかを指定します。 " アプリ パーツ " 列では、アプリ パーツの Src プロパティにトークンを使用できるかどうかを指定します。
URL の先頭で使用できるトークン
| トークン | 解決先 | スタート ページ | カスタム アクション | アプリ パーツ | 注釈 |
|---|---|---|---|---|---|
| ~controlTemplates |
現在の Web サイトの ControlTemplates 仮想フォルダーの URL |
いいえ |
いいえ |
いいえ |
|
| ~layouts |
現在の Web サイトの Layouts 仮想フォルダーの URL |
いいえ |
いいえ |
いいえ |
|
| ~site |
現在の Web サイトの URL |
いいえ |
いいえ |
はい |
|
| ~sitecollection |
現在の Web サイトの親サイト コレクションの URL |
いいえ |
いいえ |
はい |
特に示されていない場合を除き、次のテーブルのこれらのトークンは、アプリ 部分の Src プロパティ値のパス部分で使用できません。 "アプリ パーツ" は、値のクエリ文字列部分での使用を示しています。
URL 内で使用できるトークン
| トークン | 解決先 | スタート ページ | カスタム アクション | アプリ パーツ | 注釈 |
|---|---|---|---|---|---|
| {ControlTemplates} |
現在の Web サイトの ControlTemplates 仮想フォルダーの URL |
いいえ |
いいえ |
いいえ |
|
| {ItemId} |
リストまたはライブラリ内の項目の ID (整数)。 |
いいえ |
はい |
いいえ |
|
| {ItemUrl} |
作用対象のアイテムの URL |
いいえ |
はい |
いいえ |
|
| {Layouts} |
現在の Web サイトの Layouts 仮想フォルダーの URL |
いいえ |
いいえ |
いいえ |
|
| {ListId} |
現在のリストの ID (GUID) |
いいえ |
はい |
いいえ |
|
| {RecurrenceId} |
再帰イベントの再帰インデックス |
いいえ |
はい |
いいえ |
このトークンは、リスト アイテムのコンテキスト メニューでの使用がサポートされていません。 |
| {Site} |
現在の Web サイトの URL |
いいえ |
はい |
はい |
|
| {SiteCollection} |
現在の Web サイトの親サイトの URL |
いいえ |
はい |
はい |
|
| {SiteUrl} |
現在の Web サイトの URL |
いいえ |
はい |
いいえ |
|
| {Source} |
HTTP 要求の URL。 |
いいえ |
はい |
いいえ |