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

[アーティクル]
08/09/2011

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

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

このチュートリアルでは Excel を使用しますが、ここで説明する概念は上記のすべてのアプリケーションに該当します。

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

カスタム作業ウィンドウの UI のデザイン
リボンへのトグルボタンの追加
トグルボタンとカスタム作業ウィンドウの同期

注意

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

必須コンポーネント

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

Microsoft Office 開発者ツールを含むエディションの Visual Studio 2010。 詳細については、「[Office ソリューションを開発できるようにコンピューターを構成する](bb398242\(v=vs.100\).md)」を参照してください。

Microsoft Office Excel 2007 または Microsoft Excel 2010

アドインプロジェクトの作成

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

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

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

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

リボンへのトグルボタンの追加

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

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

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

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

カスタム作業ウィンドウのユーザーインターフェイスのデザイン

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

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

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

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

カスタム作業ウィンドウの作成

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

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

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

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

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

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

ThisAddIn_Startup イベントハンドラーを次のコードで置き換えます。このコードは CustomTaskPanes フィールドに TaskPaneControl オブジェクトを追加しますが、カスタム作業ウィンドウは表示しません (CustomTaskPane クラスの Visible プロパティの既定値は false です)。さらに、この Visual C# コードは 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

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

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

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

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

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

トグルボタンによるカスタム作業ウィンドウの表示/非表示の切り替え

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

トグルボタンを使用してカスタム作業ウィンドウの表示/非表示を切り替えるには

リボンデザイナーで、[Show Task Pane] トグルボタンをダブルクリックします。

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

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

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

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

アドインのテスト

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

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

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

Excel が開きリボン上に [アドイン] タブが表示されることを確認します。
リボン上の [アドイン] タブをクリックします。
[Task Pane Manager] グループの [Show Task Pane] トグルボタンをクリックします。

トグルボタンをクリックするたびに作業ウィンドウの表示/非表示が切り替わることを確認します。
作業ウィンドウが表示されたら、作業ウィンドウの隅にある [閉じる] ボタン (X) をクリックします。

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

次の手順

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

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

参照

処理手順

方法 : カスタム作業ウィンドウをアプリケーションに追加する

チュートリアル : カスタム作業ウィンドウからのアプリケーションの自動化

チュートリアル : Outlook で電子メールメッセージと共にカスタム作業ウィンドウを表示する

方法 : Outlook で電子メールメッセージと共にカスタム作業ウィンドウを表示する

概念

カスタム作業ウィンドウの概要

複数のアプリケーションウィンドウでカスタム作業ウィンドウを管理する

リボンの概要

次の方法で共有

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

必須コンポーネント

アドインプロジェクトの作成

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

リボンへのトグルボタンの追加

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

カスタム作業ウィンドウのユーザーインターフェイスのデザイン

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

カスタム作業ウィンドウの作成

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

トグルボタンによるカスタム作業ウィンドウの表示/非表示の切り替え

トグルボタンを使用してカスタム作業ウィンドウの表示/非表示を切り替えるには

アドインのテスト

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

次の手順

参照

処理手順

概念

その他のリソース

次の方法で共有

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

必須コンポーネント

アドイン プロジェクトの作成

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

リボンへのトグル ボタンの追加

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

カスタム作業ウィンドウのユーザー インターフェイスのデザイン

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

カスタム作業ウィンドウの作成

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

トグル ボタンによるカスタム作業ウィンドウの表示/非表示の切り替え

トグル ボタンを使用してカスタム作業ウィンドウの表示/非表示を切り替えるには

アドインのテスト

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

次の手順

参照

処理手順

概念

その他のリソース

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

アドインプロジェクトの作成

リボンへのトグルボタンの追加

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

カスタム作業ウィンドウのユーザーインターフェイスのデザイン

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

トグルボタンによるカスタム作業ウィンドウの表示/非表示の切り替え

トグルボタンを使用してカスタム作業ウィンドウの表示/非表示を切り替えるには