チュートリアル: カスタム作業ウィンドウをリボンボタンと同期する

このチュートリアルでは、リボンのトグルボタンをクリックしてユーザーが非表示または表示できるカスタム作業ウィンドウを作成する方法について説明します。 Microsoft Office アプリケーションには、ユーザーがカスタム作業ウィンドウを表示または非表示にする既定の方法が用意されていないため、ユーザーがクリックしてカスタム作業ウィンドウを表示または非表示にできる、ボタンなどのユーザーインターフェイス (UI) 要素を常に作成する必要があります。

適用対象: このトピックの情報は、Outlook 用 VSTO アドインプロジェクトに適用されます。詳細については、「 Office アプリケーションとプロジェクトの種類で使用できる機能」を参照してください。

このチュートリアルでは Excel を具体的に使用しますが、このチュートリアルで示した概念は、上記のアプリケーションに適用できます。

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

カスタム作業ウィンドウの UI の設計。
リボンにトグルボタンを追加する。
トグルボタンをカスタム作業ウィンドウと同期する。

注

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

[前提条件]

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

Microsoft Office 開発者ツールを含む Visual Studio のエディション。詳細については、「 Office ソリューションを開発するためのコンピューターの構成」を参照してください。
Microsoft Excel または Microsoft Excel 2013 .

アドインプロジェクトを作成する

この手順では、Excel 用の VSTO アドインプロジェクトを作成します。

新しいプロジェクトを作成するには

Excel アドインプロジェクトテンプレートを使用して、 SynchronizeTaskPaneAndRibbon という名前の Excel アドインプロジェクトを作成します。詳細については、「方法: Visual Studio で Office プロジェクトを作成する」を参照してください。

Visual Studio によって 、ThisAddIn.cs または ThisAddIn.vb コードファイルが開き、 SynchronizeTaskPaneAndRibbon プロジェクトが ソリューションエクスプローラーに追加されます。

リボンにトグルボタンを追加する

Office アプリケーション設計ガイドラインの 1 つは、ユーザーが常に Office アプリケーション UI を制御する必要があるということです。ユーザーがカスタム作業ウィンドウを制御できるようにするには、作業ウィンドウの表示と非表示を切り替えるリボン切り替えボタンを追加できます。トグルボタンを作成するには、 リボン (ビジュアルデザイナー) 項目をプロジェクトに追加します。デザイナーは、コントロールの追加と配置、コントロールのプロパティの設定、コントロールイベントの処理に役立ちます。詳細については、「リボンデザイナー」を参照してください。

リボンにトグルボタンを追加するには

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

リボンデザイナーで ManageTaskPaneRibbon.cs または ManageTaskPaneRibbon.vb ファイルが開き、既定のタブとグループが表示されます。
リボンデザイナーで、[ group1] をクリックします。
[ プロパティ ] ウィンドウで、[ ラベル ] プロパティを [作業ウィンドウマネージャー] に設定します。
ツールボックスの [Office リボンコントロール] タブから、ToggleButton を [作業ウィンドウマネージャー] グループにドラッグします。
toggleButton1 をクリックします。
[ プロパティ ] ウィンドウで、[ ラベル ] プロパティを [ 作業ウィンドウの表示] に設定します。

カスタム作業ウィンドウのユーザーインターフェイスを設計する

カスタム作業ウィンドウ用のビジュアルデザイナーはありませんが、必要なレイアウトでユーザーコントロールを設計できます。このチュートリアルの後半では、カスタム作業ウィンドウにユーザーコントロールを追加します。

カスタム作業ウィンドウのユーザーインターフェイスを設計するには

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

デザイナーでユーザーコントロールが開きます。
ツールボックスの [共通コントロール] タブから、TextBox コントロールをユーザーコントロールにドラッグします。

カスタム作業ウィンドウを作成する

VSTO アドインの起動時にカスタム作業ウィンドウを作成するには、VSTO アドインの Startup イベントハンドラーの作業ウィンドウにユーザーコントロールを追加します。既定では、カスタム作業ウィンドウは表示されません。このチュートリアルの後半では、リボンに追加したトグルボタンをユーザーがクリックしたときに作業ウィンドウを表示または非表示にするコードを追加します。

カスタム作業ウィンドウを作成するには

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

ThisAddIn クラスに次のコードを追加します。このコードは、 TaskPaneControl のインスタンスを ThisAddInのメンバーとして宣言します。

private TaskPaneControl taskPaneControl1;
private Microsoft.Office.Tools.CustomTaskPane taskPaneValue;

Private taskPaneControl1 As TaskPaneControl
Private WithEvents taskPaneValue As Microsoft.Office.Tools.CustomTaskPane

ThisAddIn_Startup イベントハンドラーを次のコードに置き換えます。このコードでは、TaskPaneControl オブジェクトを CustomTaskPanes フィールドに追加しますが、ユーザー設定の作業ウィンドウは表示されません (既定では、Visible クラスのCustomTaskPane プロパティは false です)。 Visual C# コードでは、イベントハンドラーも VisibleChanged イベントにアタッチされます。

private void ThisAddIn_Startup(object sender, System.EventArgs e)
{
    taskPaneControl1 = new TaskPaneControl();
    taskPaneValue = this.CustomTaskPanes.Add(
        taskPaneControl1, "MyCustomTaskPane");
    taskPaneValue.VisibleChanged +=
        new EventHandler(taskPaneValue_VisibleChanged);
}

Private Sub ThisAddIn_Startup(ByVal sender As Object, _
    ByVal e As System.EventArgs) Handles Me.Startup

    taskPaneControl1 = New TaskPaneControl()
    taskPaneValue = Me.CustomTaskPanes.Add( _
        taskPaneControl1, "MyCustomTaskPane")
End Sub

次のメソッドを ThisAddIn クラスに追加します。このメソッドは、 VisibleChanged イベントを処理します。ユーザーが [閉じる ] ボタン (X) をクリックして作業ウィンドウを閉じると、リボンのトグルボタンの状態が更新されます。

private void taskPaneValue_VisibleChanged(object sender, System.EventArgs e)
{
    Globals.Ribbons.ManageTaskPaneRibbon.toggleButton1.Checked = 
        taskPaneValue.Visible;
}

Private Sub taskPaneValue_VisibleChanged(ByVal sender As Object, _
    ByVal e As System.EventArgs) Handles taskPaneValue.VisibleChanged

    Globals.Ribbons.ManageTaskPaneRibbon.ToggleButton1.Checked = taskPaneValue.Visible
End Sub

ThisAddIn クラスに次のプロパティを追加します。このプロパティは、プライベート taskPaneValue オブジェクトを他のクラスに公開します。このチュートリアルの後半では、このプロパティを使用する MyRibbon クラスにコードを追加します。
- C#
- VB
```
public Microsoft.Office.Tools.CustomTaskPane TaskPane
{
    get
    {
        return taskPaneValue;
    }
}
```
```
Public ReadOnly Property TaskPane() As Microsoft.Office.Tools.CustomTaskPane
    Get
        Return taskPaneValue
    End Get
End Property
```

トグルボタンを使用してカスタム作業ウィンドウを非表示にして表示する

最後の手順では、ユーザーがリボンのトグルボタンをクリックしたときに、カスタム作業ウィンドウを表示または非表示にするコードを追加します。

トグルボタンを使用してカスタム作業ウィンドウを表示および非表示にするには

リボンデザイナーで、[ 作業ウィンドウの表示] トグルボタンをダブルクリックします。

Visual Studio では、トグルボタンのtoggleButton1_Click イベントを処理する、Clickという名前のイベントハンドラーが自動的に生成されます。 Visual Studio では、コードエディターで MyRibbon.cs または MyRibbon.vb ファイルも開きます。

toggleButton1_Click イベントハンドラーを次のコードに置き換えます。ユーザーがトグルボタンをクリックすると、このコードは、トグルボタンが押されているか押されていないかに応じて、カスタム作業ウィンドウを表示または非表示にします。

private void toggleButton1_Click(object sender, RibbonControlEventArgs e)
{
    Globals.ThisAddIn.TaskPane.Visible = ((RibbonToggleButton)sender).Checked;
}

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

    Globals.ThisAddIn.TaskPane.Visible = _
        TryCast(sender, Microsoft.Office.Tools.Ribbon.RibbonToggleButton).Checked
End Sub

アドインをテストする

プロジェクトを実行すると、カスタム作業ウィンドウが表示されずに Excel が開きます。リボンのトグルボタンをクリックして、コードをテストします。

VSTO アドインをテストするには

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

Excel が開き、[ アドイン ] タブがリボンに表示されることを確認します。
リボンの [ アドイン ] タブをクリックします。
[ 作業ウィンドウマネージャー] グループで 、[ 作業ウィンドウの表示] トグルボタンをクリックします。

トグルボタンをクリックすると、作業ウィンドウが交互に表示され、非表示になっていることを確認します。
作業ウィンドウが表示されたら、作業ウィンドウの隅にある [閉じる ] ボタン (X) をクリックします。

トグルボタンが押されていないことを確認します。

次のステップ

カスタム作業ウィンドウを作成する方法の詳細については、次のトピックを参照してください。

別のアプリケーションの VSTO アドインにカスタム作業ウィンドウを作成します。カスタム作業ウィンドウをサポートするアプリケーションの詳細については、「カスタム作業ウィンドウ」を参照してください。
カスタム作業ウィンドウからアプリケーションを自動化します。詳細については、「チュートリアル: カスタム作業ウィンドウからアプリケーションを自動化する」を参照してください。
Outlook で開かれるすべての電子メールメッセージのカスタム作業ウィンドウを作成します。詳細については、「チュートリアル: Outlook で電子メールメッセージを含むカスタム作業ウィンドウを表示する」を参照してください。

フィードバック

このページはお役に立ちましたか?

Last updated on 2025-12-12

次の方法で共有

チュートリアル: カスタム作業ウィンドウをリボン ボタンと同期する

[前提条件]

アドイン プロジェクトを作成する

新しいプロジェクトを作成するには

リボンにトグル ボタンを追加する

リボンにトグル ボタンを追加するには

カスタム作業ウィンドウのユーザー インターフェイスを設計する

カスタム作業ウィンドウのユーザー インターフェイスを設計するには