チュートリアル : 実行時のリボンコントロールの更新

[アーティクル]
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

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

このチュートリアルでは、Office アプリケーションへのリボンの読み込み後にリボンオブジェクトモデルを使用してリボン上のコントロールを更新する方法を説明します。

この例では、AdventureWorks サンプルデータベースからデータを取得し、Microsoft Office Outlook のコンボボックスとメニューに追加します。

このチュートリアルでは、次のタスクについて説明します。

新しい Outlook アドインプロジェクトの作成
カスタムリボングループのデザイン
組み込みタブへのカスタムグループの追加
実行時のリボンコントロールの更新

メモ :
次の手順で参照している Visual Studio ユーザーインターフェイス要素の一部は、お使いのコンピュータでは名前や場所が異なる場合があります。これらの要素は、使用する Visual Studio のエディションとその設定によって決まります。詳細については、「Visual Studio の設定」を参照してください。

前提条件

このチュートリアルを完了するには、次のコンポーネントが必要です。

Visual Studio Tools for Office (Visual Studio 2008 Professional および Visual Studio Team System のオプションの要素)
Microsoft Office Outlook 2007
SQL Server Express 用の AdventureWorks サンプルデータベースへのアクセス。AdventureWorks データベースのインストール方法の詳細については、「チュートリアル : AdventureWorks データベースのインストール」を参照してください。

ここに挙げた Visual Studio のバージョンでは、Visual Studio Tools for Office が既定でインストールされます。インストールされているかどうかを確認する方法については、「Visual Studio Tools for Office のインストール」を参照してください。

新しい Outlook アドインプロジェクトの作成

まず、Outlook アドインプロジェクトを作成します。

新しい Outlook アドインプロジェクトを作成するには

Visual Studio で、MyOutlookAddIn という名前の Outlook 2007 アドインプロジェクトを作成します。
[新しいプロジェクト] ダイアログボックスの [ソリューションのディレクトリを作成] チェックボックスをオンにします。
プロジェクトを既定のプロジェクトディレクトリに保存します。

詳細については、「方法 : Visual Studio Tools for Office プロジェクトを作成する」を参照してください。

カスタムリボングループのデザイン

リボンは Outlook のメインインターフェイス領域には表示されないため、この例のリボンはユーザーが新しいメールメッセージを作成したときに表示されます。リボンのカスタムグループを作成するには、まずプロジェクトにリボン項目を追加し、次にリボンデザイナでカスタムグループをデザインします。このカスタムグループでは、データベースから顧客名と注文履歴を取得して、顧客へのフォローアップ電子メールメッセージを作成できます。

カスタムグループをデザインするには

[プロジェクト] メニューの [新しい項目の追加] をクリックします。
[新しい項目の追加] ダイアログボックスで、[リボン (ビジュアルデザイナ)] をクリックします。
新しいリボンの名前を CustomerRibbon に変更し、[追加] をクリックします。

リボンデザイナで CustomerRibbon.cs ファイルまたは CustomerRibbon.vb ファイルが開き、既定のタブとグループが表示されます。
リボンデザイナをクリックして選択します。
[表示] メニューの [プロパティウィンドウ] をクリックします。
[プロパティ] ウィンドウで、[RibbonType] プロパティの隣のドロップダウン矢印をクリックし、[Microsoft.Outlook.Mail.Compose] をクリックします。

これにより、ユーザーが Outlook で新しいメールメッセージを作成するときにリボンが表示されます。
リボンデザイナで [Group1] をクリックして選択します。
[プロパティ] ウィンドウで、[ラベル] を Customer Purchases に設定します。
[ツールボックス] の [Office リボンコントロール] タブから ComboBox を [Customer Purchases] グループにドラッグします。
[ComboBox1] をクリックして選択します。
[プロパティ] ウィンドウで、[ラベル] を Customers に設定します。
[ツールボックス] の [Office リボンコントロール] タブから Menu を [Customer Purchases] グループにドラッグします。
[プロパティ] ウィンドウで、[ラベル] を Product Purchased に設定します。
[ダイナミック] を true に設定します。

これにより、リボンが Office アプリケーションに読み込まれた後で、実行時にメニュー上のコントロールを追加および削除できます。

カスタムグループの組み込みタブへの追加

組み込みタブは、Outlook インスペクタのリボンに始めから含まれているタブです。この手順では、組み込みタブにカスタムグループを追加し、タブ上のカスタムグループの位置を指定します。

組み込みタブにカスタムグループを追加するには

[TabAddIns (ビルトイン)] タブをクリックして選択します。
[プロパティ] ウィンドウで、[ControlId] プロパティを展開し、[OfficeId] を TabNewMailMessage に設定します。

[Customer Purchases] グループが新しいメールメッセージ内に表示されるリボンの [Messages] タブに追加されます。
[Customer Purchases] グループをクリックして選択します。
[プロパティ] ウィンドウで、[位置] プロパティを展開し、[PositionType] プロパティの隣にあるドロップダウン矢印をクリックします。次に、[BeforeOfficeId] をクリックします。
[OfficeId] プロパティを GroupClipBoard に設定します。

これにより、[Customer Purchases] グループが [Messages] タブの [Clipboard] グループの前に配置されます。

実行時のカスタムグループのコントロールの更新

リボンオブジェクトモデルを使用して、以下のタスクを実行します。

[Customers] コンボボックスに顧客名を追加する。
[Products Purchased] メニューに販売注文と販売済み製品を表すメニューコントロールおよびチェックボックスコントロールを追加する。
[Customers] コンボボックスと [Products Purchased] メニューを使用して、新しいメールメッセージの Microsoft.Office.Interop.Outlook.MailItem.To、Microsoft.Office.Interop.Outlook.MailItem.Subject、Microsoft.Office.Interop.Outlook.MailItem.Body の各フィールドにデータを追加する。

リボンオブジェクトモデルを使用してカスタムグループのコントロールを更新するには

[プロジェクト] メニューの [参照の追加] をクリックします。
[参照の追加] ダイアログボックスで、[.NET] タブをクリックし、System.Data.Linq アセンブリを選択して、[OK] をクリックします。

このアセンブリには、統合言語クエリ (LINQ: Language-Integrated Query) を使用するためのクラスが含まれています。ここでは、LINQ を使用して、カスタムグループのコントロールに AdventureWorks データベースから取得したデータを追加します。LINQ の詳細については、「統合言語クエリ (LINQ: Language-Integrated Query)」を参照してください。
ソリューションエクスプローラで、CustomerRibbon.cs または CustomerRibbon.vb をクリックして選択します。
[表示] メニューの [コード] をクリックします。

コードエディタでリボンコードファイルが開きます。

リボンコードファイルの先頭に次のステートメントを追加します。これらのステートメントによって、LINQ 名前空間や Outlook プライマリ相互運用機能アセンブリ (PIA) の名前空間に容易にアクセスできます。

Imports Microsoft.Office.Tools.Ribbon
Imports System.Data.Linq
Imports System.Linq
Imports System.Data.Linq.Mapping
Imports System.Linq.Expressions
Imports Outlook = Microsoft.Office.Interop.Outlook

using System.Data.Linq;
using System.Linq;
using System.Data.Linq.Mapping;
using System.Linq.Expressions;
using Outlook = Microsoft.Office.Interop.Outlook;
using System.IO;

リボンコードファイルに次のクラスを追加します。これらのクラスを使用して、AdventureWorks データベースの Customer、Contact、Sales Order Header、Sales Order Detail、Product の各テーブルの情報を格納します。

' Customer Table.
<Table(Name:="Sales.Customer")> _
Public Class Customer
    <Column(IsPrimaryKey:=True)> _
        Public CustomerID As Integer
End Class

' Contact Table.
<Table(Name:="Person.Contact")> _
Public Class Contact
    <Column(IsPrimaryKey:=True)> _
       Public ContactID As Integer
    <Column()> _
    Public LastName As String

End Class
' Sales Order Header Table.
<Table(Name:="Sales.SalesOrderHeader")> _
Public Class SalesOrderHeader
    <Column(IsPrimaryKey:=True)> _
       Public SalesOrderID As Integer
    <Column()> _
   Public SalesOrderNumber As String
    <Column()> _
    Public CustomerID As Integer
End Class

' Sales Order Detail Table.
<Table(Name:="Sales.SalesOrderDetail")> _
Public Class SalesOrderDetail
    <Column(IsPrimaryKey:=True)> _
       Public SalesOrderDetailID As Integer
    <Column()> _
   Public SalesOrderID As Integer
    <Column()> _
    Public ProductID As Integer
End Class

' Product Table.
<Table(Name:="Production.Product")> _
Public Class Product
    <Column(IsPrimaryKey:=True)> _
       Public ProductID As Integer
    <Column()> _
    Public Name As String
End Class
' Data Context Class.
Partial Public Class AdventureWorks
    Inherits DataContext
    Public Customer As Table(Of Customer)
    Public Contact As Table(Of Contact)
    Public SalesOrderHeader As Table(Of SalesOrderHeader)
    Public SalesOrderDetail As Table(Of SalesOrderDetail)
    Public Product As Table(Of Product)
    Public Sub New(ByVal connection As String)
        MyBase.New(connection)
    End Sub
End Class

// Customer Table.
[Table(Name = "Sales.Customer")]
public class Customer
{
    [Column(IsPrimaryKey = true)]
    public int CustomerID;
}

// Contact Table.
[Table(Name = "Person.Contact")]
public class Contact
{
    [Column(IsPrimaryKey = true)]
    public int ContactID;
    [Column]
    public string LastName;

}
// Sales Order Header Table.
[Table(Name = "Sales.SalesOrderHeader")]
public class SalesOrderHeader
{
    [Column(IsPrimaryKey = true)]
    public int SalesOrderID;

    [Column]
    public string SalesOrderNumber;

    [Column]
    public int CustomerID;

}
// Sales Order Detail Table.
[Table(Name = "Sales.SalesOrderDetail")]
public class SalesOrderDetail
{
    [Column(IsPrimaryKey = true)]
    public int SalesOrderDetailID;

    [Column]
    public int SalesOrderID;

    [Column]
    public int ProductID;

}
// Product Table.
[Table(Name = "Production.Product")]
public class Product
{
    [Column(IsPrimaryKey = true)]
    public int ProductID;

    [Column]
    public string Name;

}
// Data Context Table.
public partial class AdventureWorks : DataContext
{
    public Table<Customer> Customer;
    public Table<Contact> Contact;
    public Table<SalesOrderHeader> SalesOrderHeader;
    public Table<SalesOrderDetail> SalesOrderDetail;
    public Table<Product> Product;
    public AdventureWorks(string connection) : base(connection) { }
}

CustomerRibbon_Load イベントハンドラメソッドを次のコードで置き換えます。このコードでは、LINQ クエリを使用して以下のタスクを実行します。

AdventureWorks データベースに登録されている 20 の顧客の ID と名前を [Customers] コンボボックスに追加する。
PopulateSalesOrderInfo ヘルパーメソッドを呼び出す。このメソッドは、現在選択されている顧客の販売注文番号で [ProductsPurchased] メニューを更新します。

 Private Sub CustomerRibbon_Load(ByVal sender As System.Object, _
ByVal e As Microsoft.Office.Tools.Ribbon.RibbonUIEventArgs) _
    Handles MyBase.Load

     Dim programFilesDir As String = Environment.GetFolderPath _
     (Environment.SpecialFolder.ProgramFiles)
     Dim db As New AdventureWorks(programFilesDir + _
         "\Microsoft SQL Server\" + "MSSQL.1\MSSQL\Data\AdventureWorks_Data.mdf")

     Dim customerQuery = From customers In db.Customer.Take(20), contact In db.Contact _
                         Where customers.CustomerID = contact.ContactID _
             Select CustomerID = customers.CustomerID, LastName = _
                 contact.LastName

     ' Execute the query.
     For Each item In customerQuery
         Me.ComboBox1.Items.Add(New RibbonDropDownItem())
         Me.ComboBox1.Items.Last().Label = item.CustomerID.ToString() _
             + "|" + item.LastName
     Next item

     Me.ComboBox1.Text = Me.ComboBox1.Items.First().Label
     PopulateSalesOrderInfo()
 End Sub

private void CustomerRibbon_Load(object sender, RibbonUIEventArgs e)
{
    string programFilesDir = Environment.GetFolderPath
        (Environment.SpecialFolder.ProgramFiles);
    AdventureWorks db = new AdventureWorks
        (programFilesDir + "\\Microsoft SQL Server\\" + 
    "MSSQL.1\\MSSQL\\Data\\AdventureWorks_Data.mdf");
    var customerQuery = from customers in db.Customer.Take(20)
                        join contacts in db.Contact on 
                            customers.CustomerID 
                        equals contacts.ContactID
                        select new { customers.CustomerID, 
                            contacts.LastName };


    // Execute the query.
    foreach (var item in customerQuery)
    {
        this.comboBox1.Items.Add(new RibbonDropDownItem());
        this.comboBox1.Items.Last().Label = 
            item.CustomerID.ToString() + "|" + item.LastName;
    }
    this.comboBox1.Text = this.comboBox1.Items.First().Label;
    PopulateSalesOrderInfo();
}

CustomerRibbon クラスに次のコードを追加します。このコードでは、LINQ クエリを使用して以下のタスクを実行します。

選択された顧客の個々の販売注文に対応するサブメニューを [ProductsPurchased] メニューに追加する。
販売注文に関連する製品に対応するチェックボックスを各サブメニューに追加する。
各チェックボックスにイベントハンドラを追加する。

 Private Sub PopulateSalesOrderInfo()

     Dim tempArray As [String]() = comboBox1.Text.Split(New [Char]() {"|"c})
     Menu1.Items.Clear()
     Dim programFilesDir As String = Environment.GetFolderPath _
         (Environment.SpecialFolder.ProgramFiles)
     Dim db As New AdventureWorks(programFilesDir + _
         "\Microsoft SQL Server\" + "MSSQL.1\MSSQL\Data\AdventureWorks_Data.mdf")


     Dim orderQuery = From orders In db.SalesOrderHeader _
                      Where orders.CustomerID.ToString() = tempArray(0) _
                      Select SalesOrderID = _
                          orders.SalesOrderID, SalesOrderNumber = _
                              orders.SalesOrderNumber

     For Each orderItem In orderQuery
         Dim Menu2 As New RibbonMenu()
         Menu2.Dynamic = True
         Menu1.Items.Add(Menu2)
         CType(Menu1.Items.Last(), RibbonMenu).Label = _
             orderItem.SalesOrderNumber.ToString()
         CType(Menu1.Items.Last(), RibbonMenu).Tag = _
             orderItem.SalesOrderID

         Dim productQuery = From orderDetail In db.SalesOrderDetail, _
                                product In db.Product _
                            Where orderDetail.ProductID = _
                                product.ProductID _
                            And orderDetail.SalesOrderID = _
                            orderItem.SalesOrderID _
         Select productName = product.Name

         For Each productItem In productQuery
             CType(Menu1.Items.Last(), RibbonMenu).Items.Add _
                 (New RibbonCheckBox())
             CType(CType(Menu1.Items.Last(),  _
RibbonMenu).Items.Last(), RibbonCheckBox).Label = productItem
             AddHandler (CType(CType(Menu1.Items.Last(),  _
RibbonMenu).Items.Last(), RibbonCheckBox).Click), AddressOf CheckBox_Click

         Next productItem
     Next orderItem
 End Sub

private void PopulateSalesOrderInfo()
{
    String[] tempArray = comboBox1.Text.Split(new Char[] { '|' });
    menu1.Items.Clear();
    string programFilesDir = Environment.GetFolderPath
        (Environment.SpecialFolder.ProgramFiles);
    AdventureWorks db = new AdventureWorks
        (programFilesDir + "\\Microsoft SQL Server\\" +
            "MSSQL.1\\MSSQL\\Data\\AdventureWorks_Data.mdf");

    var orderQuery = from orders in db.SalesOrderHeader
                     where orders.CustomerID.ToString() == tempArray[0]
                     select new { orders.SalesOrderID, 
                         orders.SalesOrderNumber };

    foreach (var orderItem in orderQuery)
    {
        RibbonMenu menu2 = new RibbonMenu();
        menu2.Dynamic = true;
        menu1.Items.Add(menu2);
        ((RibbonMenu)menu1.Items.Last()).Label = 
            orderItem.SalesOrderNumber.ToString();
        ((RibbonMenu)menu1.Items.Last()).Tag = 
            orderItem.SalesOrderID;

        var productQuery = from orderDetail in db.SalesOrderDetail
                           join product in db.Product on 
                               orderDetail.ProductID 
                           equals product.ProductID
                           where orderDetail.SalesOrderID == 
                               orderItem.SalesOrderID
                           select new { product.Name };

        foreach (var productItem in productQuery)
        {
            ((RibbonMenu)menu1.Items.Last()).Items.Add
                (new RibbonCheckBox());
            ((RibbonCheckBox)((RibbonMenu)menu1.Items.Last()).
                Items.Last()).Label = productItem.Name;
            ((RibbonCheckBox)((RibbonMenu)menu1.Items.Last()).
                Items.Last()).Click 
                += new EventHandler<RibbonControlEventArgs>(checkBox_Click);
        }

    }
}

ソリューションエクスプローラで、リボンコードファイルをダブルクリックします。

リボンデザイナが開きます。
リボンデザイナで [Customers] コンボボックスをダブルクリックします。

リボンコードファイルがコードエディタで開き、ComboBox1_TextChanged イベントハンドラが表示されます。
ComboBox1_TextChanged イベントハンドラを次のコードで置き換えます。このコードは次のタスクを実行します。
- PopulateSalesOrderInfo ヘルパーメソッドを呼び出す。このメソッドは、現在選択されている顧客の販売注文で [Products Purchased] メニューを更新します。
- PopulateMailItem ヘルパーメソッドを呼び出す。このメソッドは、新しいメールメッセージの Microsoft.Office.Interop.Outlook.MailItem.To、Microsoft.Office.Interop.Outlook.MailItem.Subject、Microsoft.Office.Interop.Outlook.MailItem.Body の各フィールドにデータを追加します。
```
Private Sub ComboBox1_TextChanged(ByVal sender As System.Object, _
    ByVal e As Microsoft.Office.Tools.Ribbon.RibbonControlEventArgs) _
        Handles ComboBox1.TextChanged
    PopulateSalesOrderInfo()
    PopulateMailItem(ComboBox1.Text)
End Sub
```
```
private void comboBox1_TextChanged(object sender, 
    RibbonControlEventArgs e)
{
    PopulateSalesOrderInfo();
    PopulateMailItem(comboBox1.Text);
}
```

CustomerRibbon クラスに次のコードを追加します。このコードは、選択された製品の名前を新しいメールメッセージの Microsoft.Office.Interop.Outlook.MailItem.Body フィールドに追加します。

Private Sub CheckBox_Click(ByVal sender As System.Object, _
    ByVal e As Microsoft.Office.Tools.Ribbon.RibbonControlEventArgs)
    Dim application As Outlook.Application = Globals.ThisAddIn.Application
    Dim inspector As Outlook.Inspector = application.ActiveInspector()
    Dim myMailItem As Outlook.MailItem = CType(inspector.CurrentItem,  _
        Outlook.MailItem)
    Dim myCheckBox As RibbonCheckBox = CType(sender, RibbonCheckBox)
    myMailItem.Subject = "Following up on your order"
    myMailItem.Body = myMailItem.Body + ControlChars.Lf + "* " _
        + myCheckBox.Label
End Sub

private void checkBox_Click(object sender, RibbonControlEventArgs e)
{
    Outlook.Application application = Globals.ThisAddIn.Application;
    Outlook.Inspector inspector = application.ActiveInspector();
    Outlook.MailItem myMailItem = (Outlook.MailItem)inspector.CurrentItem;
    RibbonCheckBox myCheckBox = (RibbonCheckBox)sender;
    myMailItem.Subject = "Following up on your order";
    myMailItem.Body = myMailItem.Body + "\n" + "* " + myCheckBox.Label;
}

CustomerRibbon クラスに次のコードを追加します。このコードは次のタスクを実行します。

新しいメールメッセージの Microsoft.Office.Interop.Outlook.MailItem.To 行に、現在選択されている顧客の電子メールアドレスを追加する。
新しいメールメッセージの Microsoft.Office.Interop.Outlook.MailItem.Subject フィールドと Microsoft.Office.Interop.Outlook.MailItem.Body フィールドにテキストを追加する。

Private Sub PopulateMailItem(ByVal addressToLine As String)
    Dim application As Outlook.Application = Globals.ThisAddIn.Application
    Dim inspector As Outlook.Inspector = application.ActiveInspector()
    Dim myMailItem As Outlook.MailItem = _
        CType(inspector.CurrentItem, Outlook.MailItem)

    myMailItem.To = ""
    Dim tempArray As [String]() = addressToLine.Split(New [Char]() {"|"c})
    myMailItem.To = tempArray(1) + "@example.com"
    myMailItem.Subject = "Following up on your order"
    myMailItem.Body = "Hello " + tempArray(1) + ","
    myMailItem.Body = myMailItem.Body + ControlChars.Lf + _
        "We would like to get your " + _
    "feedback on the following products that you recently ordered: "
End Sub

private void PopulateMailItem(string addressToLine)
{
    Outlook.Application application = Globals.ThisAddIn.Application;
    Outlook.Inspector inspector = application.ActiveInspector();
    Outlook.MailItem myMailItem = (Outlook.MailItem)inspector.CurrentItem;

    myMailItem.To = "";
    String[] tempArray = addressToLine.Split(new Char[] { '|' });
    myMailItem.To = tempArray[1] + "@example.com";
    myMailItem.Subject = "Following up on your order";
    myMailItem.Body = "Hello " + tempArray[1] + ",";
    myMailItem.Body = myMailItem.Body + "\n" + 
        "We would like to get your " + 
            "feedback on the following products that you recently ordered: ";
}

カスタムグループのコントロールのテスト

Outlook で新しいメールを開くと、リボンの [Messages] タブに [Customer Purchases] というカスタムグループが表示されます。

顧客へのフォローアップ電子メールメッセージを作成するには、顧客を選択し、その顧客が購入した製品を選択します。[Customer Purchases] グループ内のコントロールが実行時に AdventureWorks データベースから取得されたデータで更新されます。

カスタムグループのコントロールをテストするには

F5 キーを押してプロジェクトを実行します。

Outlook が起動します。
Outlook で、[ファイル] メニューの [新規作成] をポイントし、[メールメッセージ] をクリックします。

次の処理が実行されます。
- 新しいメールメッセージインスペクタウィンドウが表示されます。
- リボンの [Messages] タブに含まれる [Clipboard] グループの前に [Customer Purchases] グループが表示されます。
- そのグループ内の [Customers] コンボボックスが AdventureWorks データベースから取得された顧客の名前で更新されます。
リボンの [Messages] タブの [Customer Purchases] グループで、[Customers] コンボボックスから顧客を選択します。

次の処理が実行されます。
- その顧客の個々の販売注文を表すメニューで [Products Purchased] メニューが更新されます。
- 顧客が購入した製品を表すチェックボックスで各販売注文メニューが更新されます。
- 選択した顧客の電子メールアドレスがメールメッセージの [宛先] 行に追加され、メールメッセージの件名と本文にテキストが挿入されます。
[Products Purchased] メニューをクリックし、いずれかの販売注文をポイントして、その販売注文に含まれる製品をクリックします。

選択した製品の名前がメールメッセージの本文に追加されます。

次の手順

Office UI をカスタマイズする方法の詳細については、次のトピックで説明します。

ドキュメントレベルのカスタマイズにコンテキストベースの UI を追加する。詳細については、「操作ウィンドウの概要」を参照してください。
標準またはカスタムの Microsoft Office Outlook フォームを拡張する。詳細については、「チュートリアル : Outlook フォーム領域のデザイン」を参照してください。
Outlook にカスタム作業ウィンドウを追加する。詳細については、「カスタム作業ウィンドウの概要」を参照してください。