構成要素: Server リボン
最終更新日: 2011年8月22日
適用対象: SharePoint Foundation 2010
この記事の内容
Server リボンのオブジェクト モデル
Server リボンに使用される XML
Server リボンに関連する内容
Server リボンについての詳細
Microsoft SharePoint Foundation の Server リボンは、SharePoint オブジェクトを使用するときのユーザー インターフェイス (UI) を統一します。リボンの最上位の要素はタブです。タブは、 サイトのページの上部に表示されます。各タブには、一連のグループがまとめられています。これらのグループには、一連のコントロールが含まれます。各グループは複数のコントロールを含むことができ、各グループの内容を示すラベルが表示されます。グループの内部には、ボタン、ドロップダウン メニュー、チェック ボックス、コンボ ボックス、分割ボタン、ギャラリーなどのコントロールが含まれます。各コントロールは固有のコマンドで操作されます。
Server リボンのオブジェクト モデル
リボンは、ECMAScript (JavaScript、JScript) オブジェクト モデルとサーバー オブジェクト モデルの両方を使用します。
サーバー オブジェクト
IRibbonMenu: リボンの実装に使用されるインターフェイスを表します。
SPRibbonButton: リボンの内部のボタンを表します。
SPRibbonCommand: リボンのコントロールによって処理されるコマンドを表します。
SPRibbonMenu: リボンに存在するメニューを表します。
SPRibbonMenuItem: リボンのメニュー内のコントロールを表します。
SPRibbonMenuSection: リボンのメニューのセクションを表します。
SPRibbonPopulateQueryCommand: XML からリボンに動的なメニューを作成するコマンドを表します。
SPRibbonQueryCommand: QueryCommand イベントに対するリボンのコマンドを表します。
ECMAScript オブジェクト
SP.Ribbon.PageManager
CUI.Page.CommandDispatcher
CUI.Page.PageComponent
Server リボンに使用される XML
機能で XML を使用して、またはユーザー カスタム アクションを使用して、Server リボンを定義およびカスタマイズできます。リボンに使用する XML では、個々のタブ、グループ、およびコントロールを定義します。Tab 要素には 1 つの Groups 要素が含まれます。各 Groups 要素には、複数の Group 要素が含まれます。Group 要素の内部には 1 つの Controls 要素があり、複数のタイプのコントロールが含まれます。使用できるコントロールのタイプについては、「Server リボンのアーキテクチャ」のリストを参照してください。次に、リボンをカスタマイズする XML コードの例を示します。
<?xml version="1.0" encoding="utf-8"?>
<Elements xmlns="https://schemas.microsoft.com/sharepoint/">
<CustomAction
Id="Ribbon.WikiPageTab.CustomGroupAndControls"
Location="CommandUI.Ribbon"
RegistrationId="100"
RegistrationType="List">
<CommandUIExtension>
<CommandUIDefinitions>
<CommandUIDefinition
Location="Ribbon.WikiPageTab.Groups._children">
<Group
Id="Ribbon.WikiPageTab.CustomGroup"
Sequence="55"
Description="Custom Group"
Title="Custom Group"
Command="EnableCustomGroup"
Template="Ribbon.Templates.Flexible2">
<Controls Id="Ribbon.WikiPageTab.CustomGroup.Controls">
<Button
Id="Ribbon.WikiPageTab.CustomGroup.Controls.CustomButton1"
Command="CustomButtonCommand1"
Image16by16="/_layouts/images/FILMSTRP.GIF"
Image32by32="/_layouts/images/PPEOPLE.GIF"
LabelText=""
TemplateAlias="o2"
Sequence="15" />
</Controls>
</Group>
</CommandUIDefinition>
</CommandUIDefinitions>
<CommandUIHandlers>
<CommandUIHandler Command="EnableCustomGroup" />
<CommandUIHandler Command="CustomButtonCommand1" CommandAction="javascript:alert('Hello, world!');" />
</CommandUIHandlers>
</CommandUIExtension>
</CustomAction>
</Elements>
SharePoint Foundation のリボンは、XML と ECMAScript (JavaScript、JScript) を使用してカスタマイズできます。XML はリボン上のコントロールを定義し、JavaScript はページでのアクションまたはページ上のオブジェクトでのアクションを実行します。SharePoint FoundationJavaScript オブジェクト モデルに存在する JavaScript または組み込みの JavaScript 関数を使用できます。また、独自の JavaScript をページに追加し、それを使用してリボンを操作することもできます。リボンのカスタマイズの詳細については、「サーバー リボンをカスタマイズする」を参照してください。