2007 Office Fluent リボンをカスタマイズする (開発者向け) (パート 2/3)
概要: この記事は、同じタイトルの記事 (1/3、3/3) と併せてお読みください。この記事には、リボン ユーザー インターフェイスのコントロールおよびメソッド シグネチャに関するリファレンス資料が記載されています (11 印刷ページ)。
Frank Rice、Microsoft Corporation
Ken Getz、MCW Technologies, LLC (英語)
発行 : 2006 年 5 月
更新 : 2006 年 11 月
適用対象 : 2007 Microsoft Office Suites、Microsoft Office Access 2007、Microsoft Office Excel 2007、Microsoft Office PowerPoint 2007、Microsoft Office Outlook 2007、Microsoft Visual Studio 2005 Tools for the 2007 Microsoft Office system
目次
概要
リボン コントロールの説明、属性、および子コントロール情報
まとめ
追加情報
概要
Microsoft Office Fluent ユーザー インターフェイス (UI) 機能は、現在の Microsoft Office アプリケーションの階層メニュー、ツール バー、および作業ウィンドウを使用した UI に代わる、効率性と検出性が向上した、よりシンプルな UI です。UI の拡張機能によって導入された革新的モデルを使用することによって、ユーザー エクスペリエンスを向上させることができます。Fluent UI を構成するコンポーネントは、拡張マークアップ言語 (XML) および従来のプログラミング言語の 1 つを使用して操作します。以降のセクションには、Fluent UI のカスタマイズに使用する各コンポーネント、メソッド、および属性の定義と説明を記載しています。この説明を参考にして、豊富な機能を備えた、直感的な環境を構築すれば、顧客の効率性と生産性を最大限に向上させることができます。
リボン コントロールの説明、属性、および子コントロール情報
以下の XML リファレンスで、リボン コントロールのマークアップについて説明します。リボンに固有の XML に関する説明と、基本的なコントロール用の XML に関する説明の 2 つのメイン セクションで構成されています。
リボン XML
以下の XML リファレンスはリボンに固有です。
customUI
すべてのリボン カスタマイズのルート タグ。
属性
共通 : なし
表 1. Fluent UI コンテナの属性とメソッド
属性/メソッド |
型/アクション |
説明 |
|---|---|---|
xmlns |
String |
https://schemas.microsoft.com/office/2006/01/customui に設定する必要があります。 |
onLoad |
コールバック |
リボンの読み込みとしてコールバック プロシージャにリボンのパラメータを渡します。これにより、関連するコードがリボンへの参照を格納して後で使用することができます。記事「2007 Office Fluent リボンをカスタマイズする (開発者向け) (パート 1/3)」の「Fluent UI を動的に更新する」を参照してください。 |
loadImage |
コールバック |
リボンに必要なすべてのイメージを読み込む単一のプロシージャを作成することができます。記事「2007 Office Fluent リボンをカスタマイズする (開発者向け) (パート 1/3)」の「イメージを読み込む」を参照してください。 |
子コントロール
commands、ribbon
commands
グローバルに再利用されるコマンドを格納します。
属性
なし
子コントロール
command
command
再利用されているコマンドを表します。
属性
共通 : enabled、getEnabled、idMso (必須)、onAction
子コントロール
なし
ribbon
Fluent UI を表します。
属性
表 2. Fluent UI の属性
属性 |
値 |
説明 |
|---|---|---|
startFromScratch |
True, False, 1, 0 |
True に設定すると、メインの組み込みタブが非表示になり、最小限の [ファイル] メニューが表示されます。 |
子コントロール
contextualTabs、officeMenu、qat、tabs
contextualTabs
特定のオブジェクトの種類 (図ツールなど) が選択されたときに表示されるタブ。
属性
なし
子コントロール
tabSet
tabSet
タブ コントロールのコレクションを表します。
属性
共通 : getVisible、idMso (必須)、visible
子コントロール
tab
qat
クイック アクセス ツール バー。[新規] モードの場合のみ作成できます。
属性
なし
子コントロール
documentControls、sharedControls
sharedControls
ドキュメント間で共有されるコントロール (通常は、documentControls を使用し、sharedControls は使用しません)。
属性
なし
子コントロール
button、control、separator
documentControls
ドキュメント固有のコントロール。
属性
なし
子コントロール
button、control、separator
officeMenu
Microsoft 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
基本的なコントロール
以下の XML リファレンスで、基本的なコントロールについて説明します。
box
グループ内にコントロールを配置します。
属性
共通 : getVisible、id、idQ、insertAfterMso、insertAfterQ、insertBeforeMso、insertBeforeQ、visible
表 3. box の属性
属性 |
値 |
説明 |
|---|---|---|
boxStyle |
Horizontal, Vertical |
ボックス内のコントロールの視覚的な流れを決定します。 |
子コントロール
box、button、buttonGroup、checkBox、comboBox、control、dropdown、dynamicMenu、editBox、gallery、labelControl、menu、splitButton、toggleButton
button
ボタン コントロールを表します。
属性
共通 : description、enabled、getDescription、getEnabled、getImage、getImageMso、getKeytip、getLabel、getScreentip、getShowImage、getShowLabel、getSize、getSupertip、getVisible、id、idMso、idQ、image、imageMso、insertAfterMso、insertAfterQ、insertBeforeMso、insertBeforeQ、keytip、label、onAction、screentip、showImage、showLabel、size、supertip、tag、visible
子コントロール
なし
buttonGroup
ボタンのグループ化を表します。
属性
共通 : getVisible、id、idQ、insertAfterMso、insertAfterQ、insertBeforeMso、insertBeforeQ、visible
子コントロール
button、control、dynamicMenu、gallery、menu、splitButton、toggleButton
checkBox
チェック ボックス コントロールを表します。
属性
共通 : description、enabled、getDescription、getEnabled、getKeytip、getLabel、getScreentip、getSupertip、getVisible、id、idMso、idQ、insertAfterMso、insertAfterQ、insertBeforeMso、insertBeforeQ、keytip、label、onAction、screentip、supertip、tag、visible
表 4. checkBox の属性
属性 |
型/アクション |
説明 |
|---|---|---|
getPressed |
コールバック |
チェック ボックス コントロールが押されているかどうかを指定できます。 |
子コントロール
なし
comboBox
コンボ ボックス コントロールを表します。
属性
共通 : enabled、getEnabled、getImage、getImageMso、getKeytip、getLabel、getScreentip、getShowImage、getShowLabel、getSupertip、getVisible、id、idMso、idQ、image、imageMso、insertAfterMso、insertAfterQ、insertBeforeMso、insertBeforeQ、label、screentip、showImage、showLabel、supertip、tag、visible
editBox と共通 : getText、maxLength、onChange、sizeString
表 5. comboBox の属性とメソッド
メソッド |
属性/メソッド |
説明 |
|---|---|---|
getItemCount |
コールバック |
この comboBox 内の項目数を取得します。 |
getItemID |
コールバック |
この項目の ID を取得します。 |
getItemImage |
コールバック |
この項目のイメージを取得します。 |
getItemLabel |
コールバック |
この項目のラベルを取得します。 |
getItemScreentip |
コールバック |
この項目のヒントを取得します。 |
getItemSupertip |
コールバック |
この項目の特別ヒントを取得します。 |
showItemImage |
True, False, 1, 0 |
項目イメージを表示するかどうかを指定します。 |
子コントロール
item
dialogBoxLauncher
グループのダイアログ ボックス起動プログラムを格納します。グループには 1 つの dialogBoxLauncher コントロールのみを格納することができます。このコントロールにはボタン コントロールを格納する必要があります。また、このコントロールは、含まれるグループ要素内の最後の要素として表示される必要があります。
属性
なし
子コントロール
button (必須)
dropDown
ドロップダウン リスト ボックスを表します。
属性
共通 : enabled、getEnabled、getImage、getImageMso、getKeytip、getLabel、getScreentip、getShowImage、getShowLabel、getSupertip、getVisible、id、idMso、idQ、image、imageMso、insertAfterMso、insertAfterQ、insertBeforeMso、insertBeforeQ、keytip、label、onAction、screentip、showImage、showLabel、supertip、tag、visible
comboBox と共通 : getItemCount、getItemID、getItemImage、getItemLabel、getItemScreentip、getItemSupertip、showItemImage
editBox と共通 : sizeString
表 6. dropDown の属性とメソッド
メソッド |
アクション |
説明 |
|---|---|---|
getSelectedItemID |
コールバック |
ID で選択する必要のある項目を問い合わせます。この属性か、または getSelectedItemIndex 属性のいずれかを指定します。 |
getSelectedItemIndex |
コールバック |
インデックスで選択する必要のある項目を問い合わせます。この属性か、または getSelectedItemId 属性のいずれかを指定します。 |
showItemLabel |
True, False, 1, 0 |
項目がラベルを表示するかどうかを示します。 |
子コントロール
item
dynamicMenu
実行時に作成されるメニューを表します。
属性
共通 : description、enabled、getDescription、getEnabled、getImage、getImageMso、getKeytip、getLabel、getScreentip、getShowImage、getShowLabel、getSize、getSupertip、getVisible、id、idMso、idQ、image、imageMso、insertAfterMso、insertAfterQ、insertBeforeMso、insertBeforeQ、keytip、label、screentip、showImage、showLabel、supertip、tag、visible
表 7. dynamicMenu のメソッド
メソッド |
アクション |
説明 |
|---|---|---|
getContent |
コールバック |
この動的メニューの内容を含む XML 文字列を取得します。 |
getContent メソッドは、メニューに設定するために次に示すような XML を返す必要があります。
<menu xmlns="https://schemas.microsoft.com/office/2006/01/customui">
<button id="dynaButton" label="Button"
onAction="OnAction" imageMso="FoxPro"/>
<toggleButton id="dynaToggleButton" label="Toggle Button"
onAction="OnToggleAction" image="logo.bmp"/>
<menuSeparator id="div2"/>
<dynamicMenu id="subMenu" label="Sub Menu" getContent="GetSubContent" />
</menu>
子コントロール
menu と同じですが、getContent コールバックを使用して設定されます。
editBox
編集ボックス コントロールを表します。
属性
共通 : enabled、getEnabled、getImage、getImageMso、getKeytip、getLabel、getScreentip、getShowImage、getShowLabel、getSupertip、getVisible、id、idMso、idQ、image、imageMso、insertAfterMso、insertAfterQ、insertBeforeMso、insertBeforeQ、keytip、label、screentip、showImage、showLabel、supertip、tag、visible
表 8. editBox の属性とメソッド
属性/メソッド |
型/アクション |
説明 |
|---|---|---|
getText |
コールバック |
editBox に表示するテキストを取得します。 |
maxLength |
Integer |
ユーザーが入力できる最大文字数。 |
onChange |
コールバック |
ユーザーが editBox の値を変更して確定したときに呼び出される関数。 |
sizeString |
String |
editBox のサイズを決定する、"wwwwwwwwww" のような文字列。 |
子コントロール
なし
gallery
ギャラリー コントロールを表します。
属性
共通 : description、enabled、getDescription、getEnabled、getImage、getImageMso、getKeytip、getLabel、getScreentip、getShowImage、getShowLabel、getSize、getSupertip、getVisible、id、idMso、idQ、image、imageMso、insertAfterMso、insertAfterQ、insertBeforeMso、insertBeforeQ、keytip、label、onAction、screentip、showImage、showLabel、size、supertip、tag、visible
comboBox と共通 : getItemCount、getItemID、getItemImage、getItemLabel、getItemScreentip、getItemSupertip、showItemImage、showItemLabel
dropDown と共通 : getSelectedItemID、getSelectedItemIndex
editBox と共通 : sizeString
表 9. gallery の属性とメソッド
属性/メソッド |
型/アクション |
説明 |
|---|---|---|
columns |
Integer |
このギャラリーに表示する列数。 |
getItemHeight |
コールバック |
項目の高さ (ピクセル) を問い合わせます。 |
getItemWidth |
コールバック |
項目の幅 (ピクセル) を問い合わせます。 |
itemHeight |
Integer |
項目の高さ (ピクセル)。 |
itemWidth |
Integer |
項目の幅 (ピクセル)。 |
rows |
Integer |
このギャラリーに表示する行数。 |
子コントロール
item、button。button は項目の後ろに表示され、ギャラリーの一番下に表示される必要があります。
item
gallery、dropDown、または comboBox の静的項目。静的項目を指定した場合、動的項目は指定できません。
属性
共通 : id、image、imageMso、label、screentip、supertip
子コントロール
なし
labelControl
ラベル コントロールを表します。
属性
共通 : enabled、getEnabled、getLabel、getScreentip、getShowLabel、getSupertip、getVisible、id、idMso、idQ、insertAfterMso、insertAfterQ、insertBeforeMso、insertBeforeQ、label、screentip、showLabel、supertip、tag、visible
子コントロール
なし
menu
メニュー コントロールを表します。
属性
共通 : description、enabled、getDescription、getEnabled、getImage、getImageMso、getKeytip、getLabel、getScreentip、getShowImage、getShowLabel、getSize、getSupertip、getVisible、id、idMso、idQ、image、imageMso、insertAfterMso、insertAfterQ、insertBeforeMso、insertBeforeQ、keytip、label、screentip、showImage、showLabel、size、supertip、tag、visible
表 10. menu の属性
属性 |
値 |
説明 |
|---|---|---|
itemSize |
Normal, Large |
メニュー内の項目のサイズ。大きいサイズ (Large) のメニュー項目には Description プロパティが表示されます。 |
子コントロール
button、checkBox、control、dynamicMenu、gallery、menu、menuSeparator、splitButton、toggleButton
menuSeparator
メニュー アイテム間の区切り線を表します (オプションでテキスト ラベルを含めることもできます)。
属性
共通 : id、idQ、insertAfterMso、insertAfterQ、insertBeforeMso、insertBeforeQ
表 11. menuSeparator の属性とメソッド
属性 |
型/アクション |
説明 |
|---|---|---|
title |
String |
この区切り記号のテキスト。 |
getTitle |
コールバック |
この区切り記号のテキストに対するコールバック。 |
子コントロール
なし
separator
コントロール間の区切り線を表します。
属性
共通 : getVisible、id、idQ、insertAfterMso、insertAfterQ、insertBeforeMso、insertBeforeQ、visible
子コントロール
なし
splitButton
分割ボタン コントロールを表します。
属性
共通 : enabled、getEnabled、getKeytip、getShowLabel、getSize、getSupertip、getVisible、id、idMso、idQ、insertAfterMso、insertAfterQ、insertBeforeMso、insertBeforeQ、keytip、showLabel (ボタン コントロールまたはトグル ボタン コントロールのどちらがそのラベルを表示するのかを決定します)、size、supertip、tag、visible
子コントロール
button または toggleButton (必須。どちらか 1 つ。メニューの前に表示します) : 分割ボタン コントロール用のメイン ボタン。
menu (必須。1 つのみ) : 分割ボタン コントロールのメニュー。
toggleButton
トグル ボタン コントロールを表します。
属性
共通 : description、enabled、getDescription、getEnabled、getImage、getImageMso、getKeytip、getLabel、getPressed、getScreentip、getShowImage、getShowLabel、getSize、getSupertip、getVisible、id、idMso、idQ、image、imageMso、insertAfterMso、insertAfterQ、insertBeforeMso、insertBeforeQ、keytip、label、onAction、screentip、showImage、showLabel、size、supertip、tag、visible
表 12. toggleButton の属性
属性 |
型/アクション |
説明 |
|---|---|---|
getPressed |
コールバック |
トグル ボタン コントロールが押されているかどうかを指定できます。 |
子コントロール
なし
まとめ
この記事および同じタイトルの記事 (1/3、3/3) は、顧客のニーズに合わせた、プロフェッショナルなソリューションの開発に必要な情報を提供しています。最初の記事に記載されているカスタマイズの例を基に UI を作成すると、顧客が最も必要とするコントロールやオプションを操作しやすい場所に配置することができます。この記事にあるリファレンス情報を参考にして、リボン UI の外観を詳細に定義することができます。この記事のシリーズの 3/3 には、よく寄せられる質問への回答の一覧が記載されています。記載されている情報を適用することによって、革新的で魅力のある独自のソリューションを作成して、競合する他のアプリケーションと差別化することができます。
追加情報
この記事に記載されている製品およびテクノロジの詳細については、以下の追加情報を参照してください。