チュートリアル: VSTO アドインプロジェクトの実行時にワークシートにコントロールを追加する

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

Excel VSTO アドインを使用して、任意の開いているワークシートにコントロールを追加できます。このチュートリアルでは、リボンを使用してユーザーがワークシートに Button、NamedRange、および ListObject を追加できるようにする方法を説明します。詳しくは、「実行時に Office ドキュメントにコントロールを追加する」をご覧ください。

対象: このトピックの情報は、Excel の VSTO アドインのプロジェクトに適用されます。詳細については、「 Features Available by Office Application and Project Type」を参照してください。

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

ワークシートにコントロールを追加するためのユーザーインターフェイス (UI) を提供する。
ワークシートにコントロールを追加する。
ワークシートからコントロールを削除する。

Note

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

必須コンポーネント

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

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

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

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

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

Visual Studio で、ExcelDynamicControls という名前の Excel VSTO アドインプロジェクトを作成します。詳細については、「 How to: Create Office Projects in Visual Studio」を参照してください。
Microsoft.Office.Tools.Excel.v4.0.Utilities.dll アセンブリへの参照を追加します。この参照は、このチュートリアルの後半で Windows フォームコントロールをワークシートにプログラムを使用して追加するのに必要です。

ワークシートにコントロールを追加するための UI を提供する

Excel のリボンにカスタムタブを追加します。ユーザーはタブにあるチェックボックスをオンにして、ワークシートにコントロールを追加できます。

ワークシートにコントロールを追加するための UI を提供するには

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

リボンデザイナーで Ribbon1.cs または Ribbon1.vb という名前のファイルが開き、既定のタブとグループが表示されます。
ツールボックスの [Office リボンコントロール] タブから、CheckBox コントロールを group1 にドラッグします。
[CheckBox1] をクリックしてオンにします。
[プロパティ] ウィンドウで、次のプロパティを変更します。

プロパティ値

名前 Button

ラベル Button
group1に 2 つ目のチェックボックスを追加し、次のプロパティを変更します。

プロパティ値

名前 Namedrange

ラベル Namedrange
group1 に 3 つ目のチェックボックスを追加し、次のプロパティを変更します。

プロパティ値

名前 Listobject

ラベル Listobject

プロパティ	値
名前	Button
ラベル	Button

プロパティ	値
名前	Namedrange
ラベル	Namedrange

プロパティ	値
名前	Listobject
ラベル	Listobject

ワークシートにコントロールを追加する

マネージドコントロールは、ホスト項目に対してのみ追加できます。これは、コンテナーとして機能します。 VSTO アドインプロジェクトは任意の開いているブックを操作するため、VSTO アドインはワークシートをホスト項目に変換するか、または既存のホスト項目を取得してから、コントロールを追加します。開いているワークシートに基づく Worksheet ホスト項目を生成するように、各コントロールのクリックイベントハンドラーにコードを追加します。次に、ワークシートの現在選択されている位置に Button、NamedRange、および ListObject を追加します。

ワークシートにコントロールを追加するには

リボンデザイナーで [Button] をダブルクリックします。

[Button] チェックボックスの Click イベントハンドラーがコードエディターで開きます。

Button_Click イベントハンドラーを次のコードで置き換えます。

このコードでは、GetVstoObject メソッドを使用してブックの最初のワークシートを表すホスト項目を取得し、現在選択されているセルに Button コントロールを追加します。

private void Button_Click(object sender, RibbonControlEventArgs e)
{
    Worksheet worksheet = Globals.Factory.GetVstoObject(
        Globals.ThisAddIn.Application.ActiveWorkbook.Worksheets[1]);

    
    string buttonName = "MyButton";

    if (((RibbonCheckBox)sender).Checked)
    {
        Excel.Range selection = Globals.ThisAddIn.Application.Selection as Excel.Range;
        if (selection != null)
        {
            Microsoft.Office.Tools.Excel.Controls.Button button =
                new Microsoft.Office.Tools.Excel.Controls.Button();
            worksheet.Controls.AddControl(button, selection, buttonName);
        }
    }
    else
    {
        worksheet.Controls.Remove(buttonName);
    }
}

Private Sub Button_Click(ByVal sender As System.Object, _
    ByVal e As Microsoft.Office.Tools.Ribbon.RibbonControlEventArgs) _
        Handles Button.Click

    Dim NativeWorksheet As Microsoft.Office.Interop.Excel.Worksheet =
        Globals.ThisAddIn.Application.ActiveWorkbook.Worksheets(1)

    Dim worksheet As Microsoft.Office.Tools.Excel.Worksheet =
        Globals.Factory.GetVstoObject(NativeWorksheet)


    Dim buttonName As String = "MyButton"

    If CType(sender, RibbonCheckBox).Checked Then
        Dim selection As Excel.Range = Globals.ThisAddIn.Application.Selection
        If Not (selection Is Nothing) Then
            Dim button As New Microsoft.Office.Tools.Excel.Controls.Button()
            worksheet.Controls.AddControl(button, selection, buttonName)
        End If
    Else
        worksheet.Controls.Remove(buttonName)
    End If
End Sub

ソリューションエクスプローラーで、Ribbon1.cs または Ribbon1.vb を選択します。
[表示] メニューの [デザイナー] をクリックします。
リボンデザイナーで [NamedRange] をダブルクリックします。

NamedRange_Click イベントハンドラーを次のコードで置き換えます。

このコードでは、GetVstoObject メソッドを使用してブックの最初のワークシートを表すホスト項目を取得し、現在選択されている (1 つまたは複数の) セルの NamedRange コントロールを定義します。

private void NamedRange_Click(object sender, RibbonControlEventArgs e)
{
    Worksheet worksheet = Globals.Factory.GetVstoObject(
        Globals.ThisAddIn.Application.ActiveWorkbook.Worksheets[1]);


    string Name = "MyNamedRange";

    if (((RibbonCheckBox)sender).Checked)
    {
        Excel.Range selection = Globals.ThisAddIn.Application.Selection as Excel.Range;
        if (selection != null)
        {
            worksheet.Controls.AddNamedRange(selection, Name);
        }
    }
    else
    {
        worksheet.Controls.Remove(Name);
    }
}

Private Sub NamedRange_Click(ByVal sender As System.Object, _
    ByVal e As Microsoft.Office.Tools.Ribbon.RibbonControlEventArgs) _
        Handles NamedRange.Click

    Dim NativeWorksheet As Microsoft.Office.Interop.Excel.Worksheet =
        Globals.ThisAddIn.Application.ActiveWorkbook.Worksheets(1)

    Dim worksheet As Microsoft.Office.Tools.Excel.Worksheet =
        Globals.Factory.GetVstoObject(NativeWorksheet)

    Dim rangeName As String = "MyNamedRange"

    If CType(sender, RibbonCheckBox).Checked Then
        Dim selection As Excel.Range = Globals.ThisAddIn.Application.Selection
        If Not (selection Is Nothing) Then
            Dim namedRange As NamedRange = _
                worksheet.Controls.AddNamedRange(selection, rangeName)
        End If
    Else
        worksheet.Controls.Remove(rangeName)
    End If
End Sub

リボンデザイナーで [ListObject] をダブルクリックします。

ListObject_Click イベントハンドラーを次のコードで置き換えます。

このコードでは、GetVstoObject メソッドを使用してブックの最初のワークシートを表すホスト項目を取得し、現在選択されている (1 つまたは複数の) セルの ListObject を定義します。

private void ListObject_Click(object sender, RibbonControlEventArgs e)
{
    Worksheet worksheet = Globals.Factory.GetVstoObject(
        Globals.ThisAddIn.Application.ActiveWorkbook.Worksheets[1]);


    string listObjectName = "MyListObject";

    if (((RibbonCheckBox)sender).Checked)
    {
        Excel.Range selection = Globals.ThisAddIn.Application.Selection as Excel.Range;
        if (selection != null)
        {
            worksheet.Controls.AddListObject(selection, listObjectName);
        }
    }
    else
    {
        worksheet.Controls.Remove(listObjectName);
    }
}

Private Sub ListObject_Click(ByVal sender As System.Object, _
    ByVal e As Microsoft.Office.Tools.Ribbon.RibbonControlEventArgs) _
        Handles ListObject.Click

    Dim NativeWorksheet As Microsoft.Office.Interop.Excel.Worksheet =
        Globals.ThisAddIn.Application.ActiveWorkbook.Worksheets(1)

    Dim worksheet As Microsoft.Office.Tools.Excel.Worksheet =
        Globals.Factory.GetVstoObject(NativeWorksheet)


    Dim listObjectName As String = "MyListObject"

    If CType(sender, RibbonCheckBox).Checked Then
        Dim selection As Excel.Range = _
            Globals.ThisAddIn.Application.Selection
        If Not (selection Is Nothing) Then
            worksheet.Controls.AddListObject(selection, listObjectName)
        End If
    Else
        worksheet.Controls.Remove(listObjectName)
    End If
End Sub

リボンコードファイルの先頭に次のステートメントを追加します。

using Excel = Microsoft.Office.Interop.Excel;
using Microsoft.Office.Tools.Excel;
using Microsoft.Office.Tools.Excel.Extensions;

Imports Excel = Microsoft.Office.Interop.Excel
Imports Microsoft.Office.Tools.Excel
Imports Microsoft.Office.Tools.Excel.Extensions

ワークシートからコントロールを削除する

ワークシートが保存されて閉じられるとき、コントロールは保持されません。ワークシートを保存する前に、生成されたすべての Windows フォームコントロールをプログラムを使用して削除する必要があります。そうしないと、ワークシートを再び開いたときに、コントロールのアウトラインのみが表示されます。生成されたホスト項目のコントロールコレクションから Windows フォームコントロールを削除するコードを WorkbookBeforeSave イベントに追加します。詳しくは、「Office ドキュメントでのダイナミックコントロールの永続化」をご覧ください。

ワークシートからコントロールを削除するには

ソリューションエクスプローラーで、ThisAddIn.cs または ThisAddIn.vb を選択します。
[表示] メニューの [コード]をクリックします。

次のメソッドを ThisAddIn クラスに追加します。このコードはブックの最初のワークシートを取得し、HasVstoObject メソッドを使用して、ワークシートにワークシートオブジェクトが生成されているかどうかを確認します。生成されたワークシートオブジェクトにコントロールがある場合、コードはそのワークシートオブジェクトを取得し、コントロールコレクションを反復処理してコントロールを削除します。

       void Application_WorkbookBeforeSave(Microsoft.Office.Interop.Excel.Workbook workbook, 
           bool SaveAsUI, ref bool Cancel)
       {
           Excel.Worksheet worksheet =
               workbook.Worksheets[1] as Excel.Worksheet;
           
           if (Globals.Factory.HasVstoObject(worksheet) && 
               Globals.Factory.GetVstoObject(worksheet).Controls.Count > 0)
           {
               Worksheet vstoWorksheet = Globals.Factory.GetVstoObject(worksheet);
           
          
               
               while (vstoWorksheet.Controls.Count > 0)
               {
                   object vstoControl = vstoWorksheet.Controls[0];
                   vstoWorksheet.Controls.Remove(vstoControl);
               }

           }
       }

Sub Application_WorkbookBeforeSave _
    (ByVal workbook As Microsoft.Office.Interop.Excel.Workbook, _
     ByVal SaveAsUI As Boolean, ByRef Cancel As Boolean) _
     Handles Application.WorkbookBeforeSave

    Dim worksheet As Excel.Worksheet = workbook.Worksheets(1)

    If Globals.Factory.HasVstoObject(worksheet) And
        Globals.Factory.GetVstoObject(worksheet).Controls.Count > 0 Then
        Dim vstoWorksheet As Worksheet = Globals.Factory.GetVstoObject(worksheet)

        While vstoWorksheet.Controls.Count > 0
            Dim vstoControl As Object = vstoWorksheet.Controls(0)
            vstoWorksheet.Controls.Remove(vstoControl)
        End While
    End If
End Sub

C# では、WorkbookBeforeSave イベントのイベントハンドラーを作成する必要があります。このコードを ThisAddIn_Startup メソッドに配置できます。イベントハンドラーの作成方法について詳しくは、「方法: Office プロジェクトでイベントハンドラーを作成する」をご覧ください。 ThisAddIn_Startup メソッドを次のコードに置き換えます。
```
private void ThisAddIn_Startup(object sender, System.EventArgs e)
{
    this.Application.WorkbookBeforeSave += 
        new Microsoft.Office.Interop.Excel.AppEvents_WorkbookBeforeSaveEventHandler
            (Application_WorkbookBeforeSave);
}
```

ソリューションをテストする

リボンのカスタムタブからコントロールを選択し、ワークシートに追加します。ワークシートを保存すると、これらのコントロールは削除されます。

ソリューションをテストするには

F5 キーを押してプロジェクトを実行します。
Sheet1 で任意のセルを選択します。
[アドイン] タブをクリックします。
[group1] グループで、[Button] をクリックします。

選択したセルにボタンが表示されます。
Sheet1 で別のセルを選択します。
[group1] グループで、[NamedRange] をクリックします。

選択したセルに名前付き範囲が定義されます。
Sheet1 で一連のセルを選択します。
[group1] グループで、[ListObject] をクリックします。

選択したセルにリストオブジェクトが追加されます。
ワークシートを保存します。

Sheet1 に追加したコントロールは表示されなくなります。

次のステップ

Excel VSTO アドインプロジェクトのコントロールの詳細については、以下のトピックをご覧ください。

ワークシートにコントロールを保存する方法について詳しくは、「Office 開発のサンプルとチュートリアル」にある、Excel VSTO アドインダイナミックコントロールのサンプルをご覧ください。

次の方法で共有

チュートリアル: VSTO アドインプロジェクトの実行時にワークシートにコントロールを追加する

必須コンポーネント

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

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

ワークシートにコントロールを追加するための UI を提供する

ワークシートにコントロールを追加するための UI を提供するには

ワークシートにコントロールを追加する

ワークシートにコントロールを追加するには

ワークシートからコントロールを削除する

ワークシートからコントロールを削除するには

ソリューションをテストする

ソリューションをテストするには

次のステップ

その他のリソース

次の方法で共有

チュートリアル: VSTO アドイン プロジェクトの実行時にワークシートにコントロールを追加する

必須コンポーネント

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

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

ワークシートにコントロールを追加するための UI を提供する

ワークシートにコントロールを追加するための UI を提供するには

ワークシートにコントロールを追加する

ワークシートにコントロールを追加するには

ワークシートからコントロールを削除する

ワークシートからコントロールを削除するには

ソリューションをテストする

ソリューションをテストするには

次のステップ

関連するコンテンツ

その他のリソース

チュートリアル: VSTO アドインプロジェクトの実行時にワークシートにコントロールを追加する

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

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