カスタム作業ウィンドウ

  • [アーティクル]

作業ウィンドウは、通常、Microsoft Office アプリケーションのウィンドウの一辺にドッキングされているユーザー インターフェイス ウィンドウです。 カスタム作業ウィンドウは、独自の作業ウィンドウを作成し、ユーザーがソリューションの各機能にアクセスする際に使い慣れたインターフェイスを利用できるようにするものです。 たとえば、インターフェイスにはドキュメントを変更するコードや、データ ソースのデータを表示するコードを実行するコントロールが含まれます。

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

Note

カスタム作業ウィンドウは、操作ウィンドウとは異なります。 操作ウィンドウは、Microsoft Office Word および Microsoft Office Excel のドキュメント レベルのカスタマイズの一部です。 詳しくは、「操作ウィンドウの概要」をご覧ください。

カスタム作業ウィンドウのメリット

カスタム作業ウィンドウでは、使用する機能を使い慣れたユーザー インターフェイスに取り込むことができます。 Visual Studio のツールを使用して、カスタム作業ウィンドウをすばやく作成できます。

使い慣れたユーザー インターフェイス

Microsoft Office システムのアプリケーションのユーザーは、Word の [スタイルと書式] 作業ウィンドウなどの作業ウィンドウを既に使い慣れています。 カスタム作業ウィンドウは Microsoft Office システムの他の作業ウィンドウと似た動作をします。 ユーザーは、アプリケーション ウィンドウのいずれかの辺にカスタム作業ウィンドウをドッキングすることができます。また、ウィンドウの任意の場所にカスタム作業ウィンドウをドラッグすることができます。 複数のカスタム作業ウィンドウを同時に表示できる VSTO アドインを作成することもできます。各作業ウィンドウは、ユーザーが個別に操作できます。

Windows フォームのサポート

Visual Studio で Office 開発ツールを使用して作成したカスタム作業ウィンドウのユーザー インターフェイスは、Windows フォーム コントロールに基づいています。 使い慣れた Windows フォーム デザイナーを使用して、カスタム作業ウィンドウのユーザー インターフェイスを設計できます。 また、Windows フォームのデータ バインディング サポートを使用して、作業ウィンドウ上のコントロールにデータ ソースをバインドすることもできます。

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

2 つの手順で、基本的なカスタム作業ウィンドウを作成できます。

  1. Windows フォーム コントロールを UserControl オブジェクトに追加することにより、カスタム作業ウィンドウのユーザー インターフェイスを作成します。

  2. そのユーザー コントロールを VSTO アドインの CustomTaskPaneCollection オブジェクトに渡すことにより、カスタム作業ウィンドウをインスタンス化します。 このコレクションは、作業ウィンドウの外観を変更し、ユーザー イベントに応答するために使用できる新しい CustomTaskPane オブジェクトを返します。

    詳細については、「方法: カスタム作業ウィンドウをアプリケーションに追加する」を参照してください。

ユーザー インターフェイスを作成する

Visual Studio の Office 開発ツールを使用して作成されるすべてのカスタム作業ウィンドウには、UserControl オブジェクトが含まれます。 このユーザー コントロールは、カスタム作業ウィンドウのユーザー インターフェイスを提供します。 ユーザー コントロールは、デザイン時または実行時に作成できます。 デザイン時にユーザー コントロールを作成する場合は、Windows フォーム デザイナーを使用して、作業ウィンドウのユーザー インターフェイスを作成できます。

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

カスタム作業ウィンドウのユーザー インターフェイスが含まれるユーザー コントロールを作成した後に、CustomTaskPane をインスタンス化する必要があります。 これを実行するには、いずれかの Add メソッドを呼び出すことにより、ユーザー コントロールを VSTO アドインの CustomTaskPaneCollection に渡します。 このコレクションは、ThisAddIn クラスの CustomTaskPanes フィールドとして公開されます。 次のコード例は ThisAddIn クラスから実行することを意図しています。

myUserControl1 = new MyUserControl();
myCustomTaskPane = this.CustomTaskPanes.Add(myUserControl1, "My Task Pane");
myCustomTaskPane.Visible = true;

Add メソッドは、新しい CustomTaskPane オブジェクトを返します。 このオブジェクトを使用して、作業ウィンドウの外観を変更したり、ユーザー イベントに応答したりできます。

複数のウィンドウの作業ウィンドウを制御する

カスタム作業ウィンドウは、ドキュメント フレーム ウィンドウに関連付けられます。ドキュメント フレーム ウィンドウは、ドキュメントや項目をユーザーに表示するものです。 作業ウィンドウは、関連付けられたウィンドウが表示されている場合にのみ表示されます。

どのウィンドウが作業ウィンドウを表示するのかを決定するには、作業ウィンドウを作成するときに適切な Add メソッド オーバーロードを使用します。

  • 作業ウィンドウをアクティブなウィンドウに関連付けるには、Add メソッドを使用します。

  • 指定したウィンドウでホストされているドキュメントに作業ウィンドウを関連付けるには、Add メソッドを使用します。

    一部の Office アプリケーションでは、複数のウィンドウが開いているときに作業ウィンドウを作成する、または表示するタイミングについて、明示的な命令が必要です。 その場合、作業ウィンドウがアプリケーションで確実に適切なドキュメントや項目に表示されるようにするために、カスタム作業ウィンドウをコードのどこでインスタンス化するかを検討することが重要になります。 詳しくは、「複数のアプリケーションウィンドウでカスタム作業ウィンドウを管理する」をご覧ください。

作業ウィンドウからアプリケーションにアクセスする

ユーザー コントロールからアプリケーションを自動化する場合、コード内の Globals.ThisAddIn.Application を使用して、オブジェクト モデルに直接アクセスできます。 静的な Globals クラスは、ThisAddIn オブジェクトへのアクセスを提供します。 このオブジェクトの Application フィールドは、アプリケーションのオブジェクト モデルへのエントリ ポイントです。

ThisAddIn オブジェクトの Application フィールドについて詳しくは、「VSTO アドインのプログラミング」をご覧ください。カスタム作業ウィンドウからアプリケーションを自動化する方法を示すチュートリアルについては、「チュートリアル: アプリケーションをカスタム作業ウィンドウから自動化する」を参照してください。 Globals クラスの詳細については、「Office プロジェクト内のオブジェクトへのグローバル アクセス」を参照してください。

作業ウィンドウのユーザー インターフェイスを管理する

作業ウィンドウを作成した後に、CustomTaskPane オブジェクトのプロパティとイベントを使用して、作業ウィンドウのユーザー インターフェイスを制御したり、ユーザーが作業ウィンドウを変更したときに対応したりすることができます。

カスタム作業ウィンドウを表示させる

既定では、作業ウィンドウは表示されません。 作業ウィンドウを表示させるようにするには、Visible プロパティを true に設定する必要があります。

ユーザーはいつでも、作業ウィンドウの隅にある [閉じる] ボタン (X) をクリックして、作業ウィンドウを閉じることができます。 ただし、ユーザーがもう一度、カスタム作業ウィンドウを開くための既定の方法はありません。 ユーザーがカスタム作業ウィンドウを閉じた場合、それを表示する方法を提供しない限り、そのユーザーはカスタム作業ウィンドウを再度表示することはできません。

VSTO アドインでカスタム作業ウィンドウを作成する場合は、ユーザーがクリックしてカスタム作業ウィンドウを表示したり非表示にできる UI 要素 (ボタンなど) も作成する必要があります。 リボンのカスタマイズをサポートする Microsoft Office アプリケーションでカスタム作業ウィンドウを作成する場合は、カスタム作業ウィンドウを表示したり非表示にしたりするボタンを持つコントロール グループをリボンに追加できます。 これを行う方法について説明するチュートリアルについては、「チュートリアル: カスタム作業ウィンドウとリボン ボタンの同期」を参照してください。

リボンのカスタマイズをサポートしない Microsoft Office アプリケーションでカスタム作業ウィンドウを作成する場合は、カスタム作業ウィンドウを表示または非表示にする CommandBarButton を追加できます。

作業ウィンドウの外観を変更する

CustomTaskPane オブジェクトのプロパティを使用して、カスタム作業ウィンドウの位置とサイズを制御できます。 カスタム作業ウィンドウに含まれている UserControl オブジェクトのプロパティを使用して、カスタム作業ウィンドウの外観に、他の多くの変更を行うことができます。 たとえば、ユーザー コントロールの BackgroundImage プロパティを使用して、カスタム作業ウィンドウの背景画像を指定できます。

次の表に、CustomTaskPane プロパティを使用してカスタム作業ウィンドウに加えることができる変更をリストします。

タスク プロパティ
作業ウィンドウのサイズを変更する Height

Width
作業ウィンドウの場所を変更するには DockPosition
作業ウィンドウを非表示にする、または表示されるようにするには Visible
ユーザーが作業ウィンドウの場所を変更できないようにするには DockPositionRestrict

カスタム作業ウィンドウのイベントをプログラムする

ユーザーがカスタム作業ウィンドウを変更するときに、VSTO アドインが応答するようにしたい場合があります。 たとえば、ユーザーがウィンドウの向きを縦方向から横方向に変更した場合にコントロールの位置を変更するという局面が考えられます。

次の表に、ユーザーがカスタム作業ウィンドウに加える変更に応答するために利用できるイベントを示します。

タスク Event
ユーザーが作業ウィンドウの場所を変更したときに応答するには DockPositionChanged
ユーザーが作業ウィンドウを非表示にしたり、表示させた場合に応答するには VisibleChanged

作業ウィンドウで使用されているリソースをクリーンアップする

カスタム作業ウィンドウを作成した後、CustomTaskPane オブジェクトは VSTO アドインが実行されている限りメモリに残ります。 オブジェクトは、ユーザーが作業ウィンドウの隅にある [閉じる] ボタン (X) をクリックした後もメモリに残ります。

VSTO アドインがまだ実行している間に、作業ウィンドウで使用されたリソースをクリーンアップするには、Remove または RemoveAt メソッドを使用します。 これらのメソッドは、指定された CustomTaskPane オブジェクトを CustomTaskPanes コレクションから削除し、オブジェクトの Dispose メソッドを呼び出します。

Visual Studio Tools for Office ランタイムは VSTO アドインがアンロードされるときに、カスタム作業ウィンドウで使用されたリソースを自動的にクリーンアップします。 プロジェクトの ThisAddIn_Shutdown イベント ハンドラーで Remove や RemoveAt メソッドを呼び出すことはしないでください。 Visual Studio Tools for Office ランタイムは、ThisAddIn_Shutdown が呼び出される前に、CustomTaskPane オブジェクトで使用されているリソースをクリーンアップするため、これらのメソッドにより ObjectDisposedException がスローされます。 ThisAddIn_Shutdown について詳しくは、「Office プロジェクトのイベント」をご覧ください。

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

複数のウィンドウを使用してドキュメントやその他の項目を表示するアプリケーションでカスタム作業ウィンドウを作成する場合、その作業ウィンドウをユーザーが必要とするときに確実に表示させるには、追加の手順を実行する必要があります。

すべてのアプリケーションのカスタム作業ウィンドウは、ドキュメント フレーム ウィンドウと関連付けられます。このウィンドウは、ドキュメントや項目のビューをユーザーに表示します。 作業ウィンドウは、関連付けられたウィンドウが表示されている場合にのみ表示されます。 ただし、すべてのアプリケーションでドキュメント フレーム ウィンドウが同じ方法で使用されるわけではありません。

次のアプリケーション グループには別の開発要件があります。

Outlook

Outlook 用のカスタム作業ウィンドウを作成するときには、カスタム作業ウィンドウが特定のエクスプローラーまたはインスペクター ウィンドウに関連付けられます。 エクスプローラーは、フォルダーの内容を表示するウィンドウであり、インスペクターは電子メール メッセージやタスクなどの項目を表示するウィンドウです。

複数のエクスプ ローラーやインスペクターのウィンドウでカスタム作業ウィンドウを表示する場合は、エクスプ ローラーまたはインスペクター ウィンドウが開いたときに、カスタム作業ウィンドウの新しいインスタンスを作成する必要があります。 そのためには、エクスプ ローラーまたはインスペクター ウィンドウが作成されるときに発生するイベントを処理し、次に、イベント ハンドラーで作業ウィンドウを作成します。 どのウィンドウを表示させるかに応じて、作業ウィンドウを非表示にしたり表示させたりするように、エクスプ ローラーおよびインスペクターのイベントを処理することもできます。

作業ウィンドウを特定のエクスプローラーまたはインスペクターに関連付けるには、Add メソッドを使用して作業ウィンドウを作成し、Explorer または Inspector オブジェクトを window パラメーターに渡します。 カスタム作業ウィンドウの作成について詳しくは、「カスタム作業ウィンドウの概要」をご覧ください。

Outlook でカスタム作業ウィンドウの複数のインスタンスを防止する

Outlook のウィンドウでカスタム作業ウィンドウの複数のインスタンスが表示されないようにするには、各ウィンドウが閉じられるときに ThisAddIn クラスの CustomTaskPanes コレクションからカスタム作業ウィンドウを明示的に削除します。 ウィンドウが閉じられるときに発生するイベント (Close や Close など) で Remove メソッドを呼び出します。

カスタム作業ウィンドウを明示的に削除しない場合は、Outlook のウィンドウで、カスタム作業ウィンドウの複数のインスタンスが表示される可能性があります。 Outlook ではウィンドウが再利用されることがありますが、再利用されるウィンドウにアタッチされたカスタム作業ウィンドウがあった場合、その作業ウィンドウへの参照は再利用されるウィンドウに残ります。

Word、InfoPath、PowerPoint

Word、InfoPath、および PowerPoint ではそれぞれのドキュメントが別々のドキュメント フレーム ウィンドウに表示されます。 これらのアプリケーションのカスタム作業ウィンドウを作成する場合、そのカスタム作業ウィンドウは特定のドキュメントにのみ関連付けられます。 ユーザーが別のドキュメントを開いた場合、前のドキュメントが再度表示されるまで、カスタム作業ウィンドウは非表示です。

複数のドキュメントでカスタム作業ウィンドウを表示する場合は、ユーザーが新しいドキュメントを作成するか、既存のドキュメントを開くときに、カスタム作業ウィンドウの新しいインスタンスを作成します。 そのためには、ドキュメントが作成または開かれるときに発生するイベントを処理し、次にイベント ハンドラーで作業ウィンドウを作成します。 どのドキュメントを表示させるかに応じて作業ウィンドウを非表示にしたり表示させたりするように、ドキュメント イベントを処理することもできます。

作業ウィンドウを特定のドキュメント ウィンドウに関連付けるには、Add メソッドを使用して作業ウィンドウを作成し、window パラメーターに Window (Word の場合)、WindowObject (InfoPath の場合)、または DocumentWindow (PowerPoint の場合) を渡します。

Word のイベント

Word のドキュメント ウィンドウの状態を監視するために、次のイベントを処理できます。

InfoPath のイベント

InfoPath のドキュメント ウィンドウの状態を監視するために、次のイベントを処理できます。

PowerPoint のイベント

PowerPoint のドキュメント ウィンドウの状態を監視するために、次のイベントを処理できます。

関連するコンテンツ