リボン XML

[アーティクル]
04/28/2010

更新 : 2007 年 11 月

対象
このトピックの情報は、指定された Visual Studio Tools for Office プロジェクトおよび Microsoft Office のバージョンにのみ適用されます。プロジェクトの種類ドキュメントレベルのプロジェクトアプリケーションレベルのプロジェクト Microsoft Office のバージョン Excel 2007 Word 2007 Outlook 2007 PowerPoint 2007 詳細については、「アプリケーションおよびプロジェクトの種類別の使用可能な機能」を参照してください。

このトピックの情報は、指定された Visual Studio Tools for Office プロジェクトおよび Microsoft Office のバージョンにのみ適用されます。

プロジェクトの種類

ドキュメントレベルのプロジェクト
アプリケーションレベルのプロジェクト

Microsoft Office のバージョン

Excel 2007
Word 2007
Outlook 2007
PowerPoint 2007

詳細については、「アプリケーションおよびプロジェクトの種類別の使用可能な機能」を参照してください。

リボン (XML) 項目により、XML を使用してリボンをカスタマイズできます。リボン (XML) 項目を使用すると、リボン (ビジュアルデザイナ) 項目ではサポートされていない方法でリボンをカスタマイズできます。2 種類の項目で実行できる操作の比較については、「リボンの概要」を参照してください。

プロジェクトへのリボン (XML) 項目の追加

リボン (XML) 項目は、[新しい項目の追加] ダイアログボックスを使用することにより、どのような Visual Studio Tools for Office プロジェクトにも追加できます。Visual Studio Tools for Office によって、自動的に以下のファイルがプロジェクトに追加されます。

リボン XML ファイル。このファイルにはリボンのユーザーインターフェイス (UI) が定義されます。このファイルを使用して、タブ、グループ、コントロールなどの UI 要素を追加します。詳細については、後の「リボン XML ファイルリファレンス」を参照してください。
リボンコードファイル。このファイルには、リボンクラスが含まれています。このクラスの名前は、[新しい項目の追加] ダイアログボックスでリボン (XML) 項目に指定した名前になります。Microsoft Office アプリケーションは、このクラスのインスタンスを使用してカスタムリボンを読み込みます。詳細については、後の「リボンクラスリファレンス」を参照してください。

既定では、これらのファイルはリボンの [アドイン] タブにカスタムグループを追加します。

Microsoft Office アプリケーションでのカスタムリボンの表示

リボン (XML) 項目をプロジェクトに追加した後で、ThisAddin、ThisWorkbook、ThisDocument のいずれかのクラスに、CreateRibbonExtensibilityObject メソッドをオーバーライドして Office アプリケーションにリボン XML クラスを返すコードを追加する必要があります。

CreateRibbonExtensibilityObject メソッドをオーバーライドして Ribbon1 というリボン XML クラスを返すコードの例を次に示します。

Protected Overrides Function CreateRibbonExtensibilityObject() As  _
Microsoft.Office.Core.IRibbonExtensibility
    Return New MyRibbon()
End Function

protected override Microsoft.Office.Core.IRibbonExtensibility CreateRibbonExtensibilityObject()
{
    return new MyRibbon();
}

カスタムリボンの動作の定義

コールバックメソッドを作成すると、リボン上のボタンのクリックなどのユーザーアクションに応答できます。コールバックメソッドは、Windows フォームコントロールのイベントに似ていますが、UI 要素の XML の属性で識別されます。リボンクラスにメソッドを記述すると、コントロールは属性値と同じ名前を持つメソッドを呼び出します。たとえば、ユーザーがリボンのボタンをクリックしたときに呼び出されるコールバックメソッドを作成できます。コールバックメソッドを作成するには、次の 2 つの手順が必要です。

コードのコールバックメソッドを識別する属性をリボン XML ファイルのコントロールに割り当てます。
リボンクラスにコールバックメソッドを定義します。

メモ :
Outlook 2007 には補足の手順が必要です。詳細については、「Outlook のリボンのカスタマイズ」を参照してください。

リボンからアプリケーションを自動化する方法を示すチュートリアルについては、「チュートリアル : リボン XML によるカスタムタブの作成」を参照してください。

コントロールへのコールバックメソッドの割り当て

リボン XML ファイルのコントロールにコールバックメソッドを割り当てるには、コールバックメソッドの種類とメソッドの名前を指定する属性を追加します。たとえば、次の要素は、OnToggleButton1 という名前の onAction コールバックメソッドを持つトグルボタンを定義します。

<toggleButton id="toggleButton1" onAction="OnToggleButton1" />

ユーザーが特定のコントロールに関連した主なタスクを実行すると、onAction が呼び出されます。たとえばユーザーがボタンをクリックすると、トグルボタンの onAction コールバックメソッドが呼び出されます。

属性に指定するメソッドには、任意の名前を付けることができます。ただし、その名前は、リボンコードファイルに定義したメソッド名と一致する必要があります。

リボンコントロールに割り当てることができるコールバックメソッドには、さまざまな種類があります。各コントロールで使用できるコールバックメソッドの完全なリストについては、技術文書「Customizing the Office (2007) Ribbon User Interface for Developers (Part 3 of 3)」を参照してください。

コールバックメソッドの定義

リボンクラスのコールバックメソッドは、リボンコードファイルで定義します。コールバックメソッドには、次のような要件があります。

パブリックとして宣言する必要があります。
名前が、リボン XML ファイルのコントロールに割り当てたコールバックメソッドの名前と一致する必要があります。
シグネチャが、関連するリボンコントロールで使用可能なコールバックメソッドの型のシグネチャと一致する必要があります。

リボンコントロール用のコールバックメソッドシグネチャの完全なリストについては、技術文書「Customizing the Office (2007) Ribbon User Interface for Developers (Part 3 of 3)」を参照してください。Visual Studio Tools for Office は、リボンコードファイル内に作成したコールバックメソッドに対して IntelliSense サポートを提供しません。有効なシグネチャと一致しないコールバックメソッドを作成しても、コードはコンパイルされますが、ユーザーがコントロールをクリックしたときに何も起こりません。

すべてのコールバックメソッドには、メソッドを呼び出すコントロールを表す Microsoft.Office.Core.IRibbonControl パラメータがあります。このパラメータを使用して、複数のコントロールで同じコールバックメソッドを再利用することもできます。次のコード例は、ユーザーがクリックするコントロールに応じて異なるタスクを実行する onAction コールバックメソッドを示します。

Public Sub OnActionCallback(ByVal control As Office.IRibbonControl, _
    ByVal isPressed As Boolean)

    If (control.Id = "checkBox1") Then
        MessageBox.Show("You clicked " + control.Id)
    Else
        MessageBox.Show("You clicked a different control.")
    End If

End Sub

public void OnActionCallback(Office.IRibbonControl control, bool isPressed)
{
    if (control.Id == "checkBox1")
    {
        MessageBox.Show("You clicked " + control.Id);
    }
    else
    {
        MessageBox.Show("You clicked a different control.");
    }
}

リボン XML ファイルリファレンス

要素と属性をリボン XML ファイルに追加して、カスタムリボンを定義できます。既定では、リボン XML ファイルには次の XML が含まれています。

<?xml version="1.0" encoding="UTF-8"?>
<customUI xmlns="https://schemas.microsoft.com/office/2006/01/customui" onLoad="OnLoad">
  <ribbon>
    <tabs>
      <tab idMso="TabAddIns">
        <group id="MyGroup"
               label="My Group">
        </group>
      </tab>
    </tabs>
  </ribbon>
</customUI>

次の表で、リボン XML ファイルの既定の要素について説明します。

要素	説明
customUI	アドインプロジェクトのカスタムリボンを表します。
ribbon	リボンを表します。
tabs	リボンタブのセットを表します。
tab	1 つのリボンタブを表します。
group	リボンタブのコントロールのグループを表します。

これらの要素には、カスタムリボンの外観と動作を指定する属性があります。次の表で、リボン XML ファイルの既定の属性について説明します。

属性	親要素	説明
onLoad	customUI	アプリケーションがリボンを読み込んだときに呼び出されるメソッドを識別します。
idMso	tab	リボンに表示する組み込みタブを識別します。
id	group	グループを識別します。
label	group	グループに表示されるテキストを指定します。

リボン XML ファイルの既定の要素と属性は、使用できる要素と属性の小さいサブセットです。使用可能な要素および属性の完全なリストについては、技術文書「Customizing the Office (2007) Ribbon User Interface for Developers (Part 2 of 3)」を参照してください。

リボンクラスリファレンス

Visual Studio Tools for Office は、リボンコードファイルにリボンクラスを生成します。このクラスに、リボンのコントロールのコールバックメソッドを追加します。このクラスは、Microsoft.Office.Core.IRibbonExtensibility インターフェイスを実装します。

次の表で、このクラスの既定のメソッドについて説明します。

メソッド	説明
GetCustomUI	リボン XML ファイルの内容を返します。Microsoft Office アプリケーションは、このメソッドを呼び出して、カスタムリボンのユーザーインターフェイスを定義する XML 文字列を取得します。メモ : GetCustomUI は、リボン XML ファイルの内容を返す場合にのみ実装し、アドインの初期化には使用しないでください。特に、ダイアログボックスや他のウィンドウを GetCustomUI の実装に表示しようとしないでください。カスタムリボンが正しく動作しない可能性があります。アドインを初期化するためにコードを実行する必要がある場合は、ThisAddIn_Startup イベントハンドラにコードを追加してください。
OnLoad	Microsoft.Office.Core.IRibbonControl パラメータを ribbon フィールドに割り当てます。Microsoft Office アプリケーションは、カスタムリボンが読み込まれると、このメソッドを呼び出します。このフィールドを使用して、カスタムリボンを動的に更新することができます。詳細については、技術文書「Customizing the Office (2007) Ribbon User Interface for Developers (Part 1 of 3)」を参照してください。
GetResourceText	リボン XML ファイルの内容を取得するために GetCustomUI メソッドによって呼び出されます。

参照

処理手順

チュートリアル : リボン XML によるカスタムタブの作成

概念

リボンの概要

Office UI のカスタマイズ

次の方法で共有

リボン XML

プロジェクトへのリボン (XML) 項目の追加

Microsoft Office アプリケーションでのカスタムリボンの表示

カスタムリボンの動作の定義

コントロールへのコールバックメソッドの割り当て

コールバックメソッドの定義

リボン XML ファイルリファレンス

リボンクラスリファレンス

参照

処理手順

概念

その他のリソース

次の方法で共有

リボン XML

プロジェクトへのリボン (XML) 項目の追加

Microsoft Office アプリケーションでのカスタム リボンの表示

カスタム リボンの動作の定義

コントロールへのコールバック メソッドの割り当て

コールバック メソッドの定義

リボン XML ファイル リファレンス

リボン クラス リファレンス

参照

処理手順

概念

その他のリソース

Microsoft Office アプリケーションでのカスタムリボンの表示

カスタムリボンの動作の定義

コントロールへのコールバックメソッドの割り当て

コールバックメソッドの定義

リボン XML ファイルリファレンス

リボンクラスリファレンス