カスタム検索
リボン関連

リボンXML リファレンス

このページは下記Webページの情報を元に作成しています。

「2007 Office Fluent リボンをカスタマイズする (開発者向け) (パート 2/3)」
http://msdn.microsoft.com/ja-jp/library/aa338199.aspx

ここではリボンXMLで使われる要素や属性を紹介していきます。
XMLの細かい説明については割愛しますが、ここで使用する用語について簡単に説明をしておきます。

 

XML文書の最も基本となる情報単位で、開始タグと終了タグで囲まれた部分を「要素」と呼びます。下記の例では「customUI」と「ribbon」が要素になります。通常は「customUI」のように開始タグ(<要素名>)と終了タグ(</要素名>)で囲む必要がありますが、要素に内容が無い場合には、「ribbon」のように「<要素名 />」と記述することもできます。

 

また、下記例のように「customUI」要素の中に「ribbon」要素が含まれているとき、customUIを「親要素」、ribbonを「子要素」と呼びます。

 

さらに、要素に対して付加的な情報を付け加えるために使用される「属性」があります。下記の例では「xmlns」と「startFromScratch」が属性にあたり、開始タグの中に「属性名="属性値"」という形で記述することによって、要素に付加的な情報を追加することができます。

 

<customUI xmlns="http://schemas.microsoft.com/office/2006/01/customui">
  <ribbon startFromScratch="true" />
</customUI>

 

要素

 

box

 

説明: 水平および垂直方向にコントロールをまとめるのに役立つボックス コントロール。
子要素: box, button, buttonGroup, checkBox, comboBox, control, dropDown, dynamicMenu, editBox, gallery, labelControl, menu, splitButton, toggleButton
属性 説明 コールバック関数のVBAシグネチャ Officeバージョン
id 文字列長は 1024 文字以内に制限される。 カスタム UI 要素の ID。ID は一意でなくてはならない。   2007 , 2010
idQ 文字列長は 1024 文字以内に制限される。 正規の (qualified) コントロール ID。正規の ID によって、異なるアドインが同じカスタム グループ、タブ、およびメニューを変更することができる。   2007 , 2010
visible true, false, 1, 0 コントロールが表示されるかどうか。   2007 , 2010
getVisible コールバック。コールバックは状態の表示、プロパティの更新、またはアクションの実行に使用される。 コントロールが表示されている場合に True を返すコールバック。 Sub GetVisible(control As IRibbonControl, ByRef returnedVal) 2007 , 2010
insertAfterMso 文字列長は 1024 文字以内に制限される。 後に挿入するビルトイン コントロールの ID。
InsertBeforeMso、InsertAfterQ、InsertBeforeQ とは相互排他的関係。
  2007 , 2010
insertBeforeMso 文字列長は 1024 文字以内に制限される。 前に挿入するビルトイン コントロールの ID。
InsertAfterMso、InsertAfterQ、InsertBeforeQ とは相互排他的関係。
  2007 , 2010
insertAfterQ 文字列長は 1024 文字以内に制限される。 後に挿入するコントロールの ID。
InsertAfterMso、InsertBeforeMso、InsertBeforeQ とは相互排他的関係。
  2007 , 2010
insertBeforeQ 文字列長は 1024 文字以内に制限される。 前に挿入するコントロールの ID。
InsertAfterMso、InsertBeforeMso、InsertAfterQ とは相互排他的関係。
  2007 , 2010
boxStyle horizontal, vertical ボックス内のコントロールのフロー。   2007 , 2010

 

customUI

 

説明: リボンXMLのルート要素です。
固有属性:
属性 説明 構文
xmlns String http://schemas.microsoft.com/office/2006/01/customui に設定する必要があります。  
onLoad コールバック リボンの読み込み時に実行するコールバックを指定できます。 Sub onLoad(ribbon as IRibbonUI)
loadImage コールバック リボンで使用するすべてのイメージを読み込むことができるコールバックを指定できます。 Sub loadImage(imageID as String, ByRef returnedVal)

共通属性: なし
子要素: commands , ribbon

 

commands

 

説明: グローバルに再利用されるコマンドを格納します。
固有属性: なし
共通属性: なし
子要素: command

 

command

 

説明: 再利用されているコマンドを表します。
固有属性: なし
共通属性: enabled , getEnabled , idMso(必須) , onAction
子要素: なし

 

ribbon

 

説明: リボンUIを表します。
固有属性:
属性 説明
startFromScratch true , false , 1, 0 true に設定すると組み込みタブが非表示になります。

共通属性: なし
子要素: contextualTabs , officeMenu , qat , tabs

 

contextualTabs

 

説明: 特定の種類のオブジェクト(図ツール等)が選択されたときに表示されるタブです。
固有属性: なし
共通属性: なし
子要素: tabSet

 

tabSet

 

説明: タブ要素のコレクションを表します。
固有属性: なし
共通属性: getVisible , idMso(必須) , visible
子要素: tab

 

qat

 

説明: クイックアクセスツールバーです。startFromScratch属性がtrueの場合のみ有効になります。
固有属性: なし
共通属性: なし
子要素: documentControls , sharedControls

 

sharedControls

 

説明: ドキュメント間で共有される要素です。通常はdocumentControls要素を使用し、sharedControlsは使用しません。
固有属性: なし
共通属性: なし
子要素: button , control , separator

 

documentControls

 

説明: ドキュメント固有の要素です。
固有属性: なし
共通属性: なし
子要素: button , control , separator

 

officeMenu

 

説明: Officeボタンをクリックしたときに表示されるメニューを表します。
固有属性: なし
共通属性: なし
子要素: button , checkbox , control , dynamicMenu , gallery , menu , menuSeparator , splitButton , toggleButton

 

tabs

 

説明: タブ要素を格納します。
固有属性: なし
共通属性: なし
子要素: tab

 

tab

 

説明: リボン上のタブを表します。
固有属性: なし
共通属性: getKeytip , getLabel , getVisible , id , idMso , idQ , insertAfterMso , insertAfterQ , insertBeforeMso , insertBeforeQ , keytip , label , tag , visible
子要素: group

 

group

 

説明: リボン上のタブ内のグループを表します。
固有属性: なし
共通属性: getImage , getImageMso , getKeytip , getLabel , getScreentip , getSupertip , getVisible , id , idMso , idQ , image , imageMso , insertAfterMso , insertAfterQ , insertBeforeMso , insertBeforeQ , keytip , label , screentip , supertip , visible
子要素: box , button , buttonGroup , checkBox , comboBox , control , dialogBoxLauncher , dropDown , editBox , gallery , labelControl , menu , separator , splitButton , toggleButton

 

 

以下随時情報追加予定。