2017年2月17日 (金)

[SharePoint] Wiki ページライブラリの "ホームページ" について

SharePoint 上でチーム サイトを作成すると Wikiページライブラリが 「サイトのページ」という名称で自動作成されます。Wikiページライブラリはサイト内に複数追加できるため、用語集、製品情報などの情報で分類したりもできます。

さて、この Wiki ページライブラリには "ホーム ページ" があります。"ホーム ページ" というと、インターネットに公開されているWebサイト全般のことを思い浮かべる方も多いかもしれませんが、"最初に表示されるページ" という狭義が本来あります(厳密にはサイト内の特定のページまでアドレス指定しなくてもサイトのURLまで指定すれば勝手に表示される既定のページです)。

Wiki ページ ライブラリを新規に追加すると次の 2つのページが同時に自動生成されます。

  • ホーム.aspx
  • このライブラリの使用方法.aspx

このうち、ホーム.aspx が Wiki ページ ライブラリのホームページであり、Wiki ページライブラリのURLまで指定したときに最初に表示されるページとなります。サイドリンクバーなどに[最近使った項目]見出し配下に表示される Wikiページ ライブラリのURLをクリックすると既定では ホーム.aspx が表示されます。

さて、ここから開発面でのお話です。

Wiki ページライブラリのRootFolderオブジェクトには WelcomePageプロパティがあります。新規作成のWikiページライブラリなどは既定値が "ホーム.aspx" になっています。この値は変更できるため、同一ライブラリ内の任意のWikiページをホームページとして設定できます。たとえば、「Wikiページライブラリのホームページとなるページのタイトルが常に "ホーム" と表示されるのは、サイトのホームページと混同するので変えたいといったニーズがあれば、知っていると役立ちます。

JavaScript Object Model の例)

//Wiki ページライブラリのホームページの確認
...
var ctx=new SP.ClientContext();
//リストのオブジェクトを取得
var list = ctx.get_web().get_lists().getByTitle("Wikiページライブラリの名前");
var rootFolder=list.get_rootFolder();
ctx.load(rootFolder);
ctx.executeQueryAsync(function(){
//成功時のハンドラ
alert("結果 : rootFolder.get_welcomePage());
//set_welcomePage()メソッドの引数に任意のページを指定すればよい。最後RootFolderのupdate()メソッドを忘れずに!
},
function(){//失敗時のハンドラ});

コメント