リストアイテムの表示フォーム画面で、既定でリボンメニューの「参照」タブを選択する

JavaScript

2014.03.13

最近、お客様との会話でも話題になったり、TechNet/MSDN フォーラムでも質問が上がっていたりしたのですが、リストアイテムの表示フォーム（アイテム個別の情報が表示される画面）で既定で表示されるリボンメニューを隠したいという要望は少なからずあるようです。この画面を開くと「表示」タブが選択された状態でページが開かれ、「表示」タブに関係するリボンメニューが表示されています。ただし、その隣にある「参照」タブを選択すると、リボンメニューを閉じることができるわけですが、ページを開いた際の既定動作として「参照」タブを選択した状態にしたいというものです。

リボンメニューの動作を追っていくと、どうやら JavaScript で制御しているようなので、ページを開いた際に JavaScript をうまい具合に実行できれば、自動的に「参照」を選択した状態にできそうです。

タブを切替える JavaScript
リボンの初期化完了イベントを利用する
自動的に「参照」タブを選択する
さいごに

タブを切替える JavaScript

タブを切替える方法については、以前の SharePoint Maniacs さんの投稿にヒントがありました。

ビューを編集するとリボンのリストツールが表示されない＋1
http://sharepointmaniacs.com/archives/3512

この記事で紹介されているスクリプトに含まれるSelectRibbonTabというメソッドがそれっぽいです。実際にアイテムの表示フォームでこのメソッドを実行すると、リボンが引っ込み、「参照」タブが表示された状態となります。

あとは、このメソッドをなるべく適切なタイミングで実行してあげるということになります。

リボンの初期化完了イベントを利用する

最初は、単純にスクリプトの実行をディレイすれば良いのかな？とも思いましたが、そうこうしている内に面白いメソッドを見つけました。それが下記の MSDN で示されているメソッドです。

CUI.Page.PageManager.add_ribbonInited(value) Method
http://msdn.microsoft.com/en-us/library/office/ff409759(v=office.14).aspx

どうやら、このメソッドを利用することで、リボンの初期化完了イベント（RibbonInited event）に任意のハンドラーを追加できるようです。このハンドラーとして、先ほどのメソッドを実行するように登録してあげれば良さそうです。

自動的に「参照」タブを選択する

と、いうわけで、手元で簡単に確認した限りでは、下記の JavaScript をアイテムの表示フォームに仕込むことで期待通りの動作が実現できました。ただ、確実に実行しようとするならば、スクリプトがリボンの初期化完了イベント後に呼ばれてしまうこと等も考慮しておいたほうが良いと思います。が、まずは最小のスクリプトということで。

SP.SOD.executeOrDelayUntilScriptLoaded(function(){
	var pm = SP.Ribbon.PageManager.get_instance();
	pm.add_ribbonInited(function(){
		SelectRibbonTab("Ribbon.Read", true);
	});
}, "sp.ribbon.js");

スクリプトの中では、SP.Ribbon.PageManagerクラスからシングルトンインスタンスを取得していますが、このクラスは先ほどのCUI.Page.PageManagerクラスを継承しているものです。