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

[アーティクル]
06/19/2023

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

適用対象: このトピックの情報は、Excel、InfoPath 2013 と InfoPath 2010、Outlook、PowerPoint、Project、Visio、Word のアプリケーションのドキュメントレベルのプロジェクトおよび VSTO アドインプロジェクトに適用されます。詳細については、「Office アプリケーションおよびプロジェクトの種類別の使用可能な機能」を参照してください。

この例では、Northwind サンプルデータベースからデータを取得し、Microsoft Office Outlook のコンボボックスとメニューに読み込みます。これらのコントロールで選択した項目は、電子メールメッセージの[宛先] や [件名] などのフィールドに自動的に読み込まれます。

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

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

Note

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

前提条件

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

Microsoft Office Developer Tools が含まれている Visual Studio のエディション。詳細については、「Office ソリューションを開発できるようにコンピューターを構成する」を参照してください。
Microsoft Outlook

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

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

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

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

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

カスタムリボングループをデザインする

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

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

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

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

これにより、ユーザーが Outlook で新しいメールメッセージを作成するときにリボンを表示できます。
リボンデザイナーで、[Group1] をクリックして選択します。
[プロパティ] ウィンドウで、[ラベル] を「顧客の購入」に設定します。
[ツールボックス] の [Office リボンコントロール] タブから [コンボボックス] を [顧客の購入] グループにドラッグします。
[ComboBox1] をクリックして選択します。
[プロパティ] ウィンドウで、[ラベル] を [顧客] に設定します。
[ツールボックス] の [Office リボンコントロール] タブから [メニュー] を [顧客の購入] グループにドラッグします。
[プロパティ] ウィンドウで、[ラベル] を「購入した製品」に設定します。
[ダイナミック] を true に設定します。

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

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

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

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

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

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

これにより、[顧客の購入] グループが [メッセージ] タブの [クリップボード] グループの前に配置されます。

データソースを作成する

[データソース] ウィンドウを使用して、型指定されたデータセットをプロジェクトに追加します。

データソースを作成するには

[データ] メニューの [新しいデータソースの追加]をクリックします。

これにより、データソース構成ウィザードが開始されます。
[データベース] を選択し、[次へ] をクリックします。
[データセット] を選択し、[次へ] をクリックします。
Microsoft SQL Server Compact 4.0 の Northwind サンプルデータベースへのデータ接続を選択するか、または [新しい接続] ボタンを使用して新しい接続を追加します。
接続を選択または作成したら、[次へ] をクリックします。
[次へ] をクリックして接続文字列を保存します。
[データベースオブジェクトの選択] ページの [テーブル] を展開します。
次の各テーブルの横にあるチェックボックスをオンにします。
1. 顧客
2. 注文の詳細
3. Orders (注文)
4. 製品
[完了] をクリックします。

実行時にカスタムグループ内のコントロールを更新する

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

[顧客] コンボボックスに顧客名を追加します。
[購入した製品] メニューに、販売注文と販売済み製品を表すメニューおよびボタンコントロールを追加します。
[顧客] コンボボックスと [購入した製品] メニューのデータを使用して、新しいメールメッセージの [宛先]、[件名]、および [本文] フィールドを設定します。

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

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

このアセンブリには、統合言語クエリ (LINQ) を使用するためのクラスが含まれています。ここでは、LINQ を使用して Northwind データベースから取得したデータをカスタムグループのコントロールに読み込みます。
ソリューションエクスプローラーで、CustomerRibbon.cs または CustomerRibbon.vb をクリックして選択します。
[表示] メニューの [コード]をクリックします。

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

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

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

Imports System.Data.Linq
Imports System.Linq
Imports System.Data.Linq.Mapping
Imports System.Linq.Expressions
Imports Outlook = Microsoft.Office.Interop.Outlook
Imports Ribbon_Update_At_Runtime.Northwind40DataSetTableAdapters

CustomerRibbon クラス内に次のコードを追加します。このコードは、Northwind データベースの Customer、Orders、Order Details、および Product テーブルから取得した情報を格納するために使用するデータテーブルおよびテーブルアダプターを宣言します。

//Declare the Northwind dataset.
Northwind40DataSet nwDataSet = new Northwind40DataSet();

//Declare the data tables.

Northwind40DataSet.CustomersDataTable customerTable;
Northwind40DataSet.OrdersDataTable orderTable;
Northwind40DataSet.Order_DetailsDataTable orderDetailsTable;
Northwind40DataSet.ProductsDataTable productsTable;

//Declare the data table adapters for each table.

CustomersTableAdapter customerTableAdapter = new CustomersTableAdapter();
OrdersTableAdapter ordersTableAdapter = new OrdersTableAdapter();
Order_DetailsTableAdapter detailsTableAdapter = new Order_DetailsTableAdapter();
ProductsTableAdapter productsTableAdapter = new ProductsTableAdapter();

'Declare the Northwind data set.

Dim nwDataSet As Northwind40DataSet = New Northwind40DataSet()

'Declare the data tables.

Dim customerTable As Northwind40DataSet.CustomersDataTable
Dim orderTable As Northwind40DataSet.OrdersDataTable
Dim orderDetailsTable As Northwind40DataSet.Order_DetailsDataTable
Dim productsTable As Northwind40DataSet.ProductsDataTable

'Declare the data table adapters for each table.

Dim customersTableAdapter As CustomersTableAdapter = New CustomersTableAdapter()
Dim ordersTableAdapter As OrdersTableAdapter = New OrdersTableAdapter()
Dim detailsTableAdapter As Order_DetailsTableAdapter = New Order_DetailsTableAdapter()
Dim productsTableAdapter As ProductsTableAdapter = New ProductsTableAdapter()

CustomerRibbon クラスに次のコードブロックを追加します。このコードによって、実行時にリボンのコントロールを作成する 3 つのヘルパーメソッドが追加されます。

private RibbonDropDownItem CreateRibbonDropDownItem()
{
    return this.Factory.CreateRibbonDropDownItem();
}
private RibbonMenu CreateRibbonMenu()
{
    return this.Factory.CreateRibbonMenu();
}
private RibbonButton CreateRibbonButton()
{
    RibbonButton button = this.Factory.CreateRibbonButton();
    button.Click += new RibbonControlEventHandler(button_Click);
    return button;
}


Private Function CreateRibbonDropDownItem() As RibbonDropDownItem
    Return Me.Factory.CreateRibbonDropDownItem()
End Function

Private Function CreateRibbonMenu() As RibbonMenu
    Return Me.Factory.CreateRibbonMenu()
End Function

Private Function CreateRibbonButton() As RibbonButton
    Dim button As RibbonButton = Me.Factory.CreateRibbonButton()
    AddHandler (button.Click), AddressOf Button_Click
    Return button
End Function

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

Northwind データベース内の 20 件の顧客の ID と名前を使用して [顧客] コンボボックスを設定します。

PopulateSalesOrderInfo ヘルパーメソッドを呼び出す。このメソッドでは、現在選択されている顧客に関連する販売注文番号で [購入した製品] メニューを更新します。

private void CustomerRibbon_Load(object sender, RibbonUIEventArgs e)
{
    customerTable = nwDataSet.Customers;
    customerTableAdapter.Fill(customerTable);

    var customerQuery = from customers in customerTable.AsEnumerable().Take(20)
                        select new
                        {
                            CustomerID = customers.Field<string>("Customer ID"),
                            CustomerName = customers.Field<string>("Contact Name")
                        };


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

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

     customerTable = nwDataSet.Customers
     customersTableAdapter.Fill(customerTable)

     Dim customerQuery = From customers In customerTable.AsEnumerable.Take(20) _
             Select CustomerID = customers.Customer_ID, _
             CustomerName = customers.Contact_Name

     ' Execute the query.
     For Each item In customerQuery
         Me.ComboBox1.Items.Add(CreateRibbonDropDownItem())

         Me.ComboBox1.Items.Last().Label = item.CustomerID.ToString() _
             + "|" + item.CustomerName
     Next item

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

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

選択されている顧客に関連する個々の販売注文を示すサブメニューを [購入した製品] メニューに追加します。
販売注文に関連する製品を示すボタンを各サブメニューに追加する。

各ボタンにイベントハンドラーを追加する。

private void PopulateSalesOrderInfo()
{
    String[] tempArray = comboBox1.Text.Split(new Char[] { '|' });
    menu1.Items.Clear();

    orderTable = nwDataSet.Orders;
    orderDetailsTable = nwDataSet.Order_Details;
    productsTable = nwDataSet.Products;

    ordersTableAdapter.Fill(orderTable);
    detailsTableAdapter.Fill(orderDetailsTable);
    productsTableAdapter.Fill(productsTable);

    var orderQuery = from orders in orderTable.AsEnumerable()
                     where orders.Field<string>("Customer ID") == tempArray[1]
                     select new { OrderID = orders.Field<int>("Order ID") };

    foreach (var orderItem in orderQuery)
    {
        menu1.Items.Add(CreateRibbonMenu());

        RibbonMenu orderMenu = (RibbonMenu)menu1.Items.Last();
        orderMenu.Dynamic = true;
        orderMenu.Label = orderItem.OrderID.ToString();
        orderMenu.Tag = orderItem.OrderID;

        var productQuery = from orderDetail in orderDetailsTable.AsEnumerable()
                           join product in productsTable.AsEnumerable() on
                               orderDetail.Field<int>("Product ID")
                           equals product.Field<int>("Product ID")
                           where orderDetail.Field<int>("Order ID") ==
                               orderItem.OrderID
                           select new { ProductName = product.Field<string>("Product Name") };

        foreach (var productItem in productQuery)
        {
            RibbonButton button = CreateRibbonButton();
            button.Label = productItem.ProductName;
            orderMenu.Items.Add(button);
        }
    }
}

Private Sub PopulateSalesOrderInfo()

    Dim tempArray As [String]() = comboBox1.Text.Split(New [Char]() {"|"c})
    Menu1.Items.Clear()

    orderTable = nwDataSet.Orders
    orderDetailsTable = nwDataSet.Order_Details
    productsTable = nwDataSet.Products

    ordersTableAdapter.Fill(orderTable)
    detailsTableAdapter.Fill(orderDetailsTable)
    productsTableAdapter.Fill(productsTable)

    Dim orderQuery = From order In orderTable.AsEnumerable() _
                     Where order.Customer_ID.ToString() = tempArray(0) _
                     Select New With {.SalesOrderID = order.Order_ID}

    For Each orderItem In orderQuery
        Me.Menu1.Items.Add(CreateRibbonMenu())

        Dim orderMenu As RibbonMenu = CType(Menu1.Items.Last(), RibbonMenu)
        orderMenu.Dynamic = True
        orderMenu.Label = orderItem.SalesOrderID.ToString()
        orderMenu.Tag = orderItem.SalesOrderID

        Dim productQuery = From orderDetail In orderDetailsTable.AsEnumerable(), _
                               product In productsTable.AsEnumerable() _
                           Where orderDetail.Product_ID = _
                               product.Product_ID _
                           And orderDetail.Order_ID = _
                           orderMenu.Tag _
        Select productName = product.Product_Name

        For Each productItem In productQuery
            Dim button As RibbonButton = CreateRibbonButton()
            button.Label = productItem
            orderMenu.Items.Add(button)
        Next productItem
    Next orderItem
End Sub

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

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

リボンコードファイルがコードエディターで開き、ComboBox1_TextChanged イベントハンドラーが表示されます。
ComboBox1_TextChanged イベントハンドラーを次のコードで置き換えます。このコードは、以下のタスクを実行します。
- PopulateSalesOrderInfo ヘルパーメソッドを呼び出す。このメソッドでは、選択されている顧客に関連する販売注文で [購入した製品] メニューを更新します。
- PopulateMailItem ヘルパーメソッドを呼び出し、現在のテキスト (つまり、選択されている顧客の名前) を渡します。このメソッドでは、新しいメールメッセージの [宛先]、[件名]、[本文] フィールドを設定します。
  - C#
  - VB
```
private void comboBox1_TextChanged(object sender,
    RibbonControlEventArgs e)
{
    PopulateSalesOrderInfo();
    PopulateMailItem(comboBox1.Text);
}
```
```
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
```

次の Click イベントハンドラーを CustomerRibbon クラスに追加します。このコードでは、選択された製品の名前を新しいメールメッセージの [本文] フィールドに追加します。

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

Private Sub Button_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 myButton As RibbonButton = CType(sender, RibbonButton)
    myMailItem.Subject = "Following up on your order"
    myMailItem.Body = myMailItem.Body + ControlChars.Lf + "* " _
        + myButton.Label
End Sub

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

現在選択されている顧客の電子メールアドレスを使用して、新しいメールメッセージの [宛先] 行を設定します。

新しいメールメッセージの [件名] と [本文] フィールドにテキストを追加します。

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[0] + "@example.com";
    myMailItem.Subject = "Following up on your order";
    myMailItem.Body = "Hello " + tempArray[0] + "," +
        "\n" + "We would like to get your feedback on the " +
        "following products that you recently ordered: ";
}

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) + "," _
        + ControlChars.Lf + "We would like to get your feedback" + _
        "on the following products that you recently ordered: "
End Sub

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

Outlook で新しいメールフォームを開くと、リボンの [メッセージ] タブに [顧客の購入] というカスタムグループが表示されます。

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

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

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

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

次のアクションが発生します。
- 新しいメールメッセージのインスペクターウィンドウが表示されます。
- リボンの [メッセージ] タブで、[クリップボード] グループの前に [顧客の購入] グループが表示されます。
- そのグループ内の [顧客] コンボボックスが Northwind データベースに含まれる顧客の名前で更新されます。
リボンの [メッセージ] タブの [顧客の購入] グループで、[顧客] コンボボックスから顧客を選択します。

次のアクションが発生します。
- [購入した製品] メニューが、選択されている顧客の個々の販売注文を示すように更新されます。
- 個々の販売注文サブメニューが、その注文で購入された商品を示すように更新されます。
- 選択されている顧客の電子メールアドレスがメールメッセージの [宛先] 行に追加され、メールメッセージの件名と本文にテキストが読み込まれます。
[製品購入] メニューをクリックし、いずれかの販売注文をポイントして、その販売注文に含まれる製品をクリックします。

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

次のステップ

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

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

Share via

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

前提条件

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

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

カスタムリボングループをデザインする

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

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

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

データソースを作成する

データソースを作成するには

実行時にカスタムグループ内のコントロールを更新する

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

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

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

次のステップ

その他のリソース

Share via

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

前提条件

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

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

カスタム リボン グループをデザインする

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

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

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

データ ソースを作成する

データ ソースを作成するには

実行時にカスタム グループ内のコントロールを更新する

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

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

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

次のステップ

関連するコンテンツ

その他のリソース

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

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

カスタムリボングループをデザインする

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

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

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

データソースを作成する

データソースを作成するには

実行時にカスタムグループ内のコントロールを更新する

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

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

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