操作ウィンドウの概要

[アーティクル]
04/28/2010

更新 : 2007 年 11 月

対象
このトピックの情報は、指定された Visual Studio Tools for Office プロジェクトおよび Microsoft Office のバージョンにのみ適用されます。プロジェクトの種類ドキュメントレベルのプロジェクト Microsoft Office のバージョン 2007 Microsoft Office system Microsoft Office 2003 詳細については、「アプリケーションおよびプロジェクトの種類別の使用可能な機能」を参照してください。

このトピックの情報は、指定された Visual Studio Tools for Office プロジェクトおよび Microsoft Office のバージョンにのみ適用されます。

プロジェクトの種類

ドキュメントレベルのプロジェクト

Microsoft Office のバージョン

2007 Microsoft Office system
Microsoft Office 2003

詳細については、「アプリケーションおよびプロジェクトの種類別の使用可能な機能」を参照してください。

操作ウィンドウは、特定の Microsoft Office Word 文書または Microsoft Office Excel ブックにアタッチされる、カスタマイズ可能な [ドキュメントアクション] 作業ウィンドウです。操作ウィンドウは、Excel の [XML ソース] 作業ウィンドウや Word の [スタイルと書式] 作業ウィンドウなどの他の組み込み作業ウィンドウと同様に、Office 作業ウィンドウ内でホストされます。操作ウィンドウのユーザーインターフェイスは、Windows フォームコントロールまたは WPF コントロールを使用してデザインできます。

操作ウィンドウは、Word または Excel のドキュメントレベルのカスタマイズ内でのみ作成できます。アプリケーションレベルのアドイン内に操作ウィンドウを作成することはできません。

メモ :
操作ウィンドウは、カスタム作業ウィンドウとは異なります。カスタム作業ウィンドウは、特定のドキュメントではなく、アプリケーションに関連付けられています。カスタム作業ウィンドウは、2007 Microsoft Office system 用のアプリケーションレベルのアドインに追加できます。詳細については、「カスタム作業ウィンドウの概要」を参照してください。

操作ウィンドウは、カスタム作業ウィンドウとは異なります。カスタム作業ウィンドウは、特定のドキュメントではなく、アプリケーションに関連付けられています。カスタム作業ウィンドウは、2007 Microsoft Office system 用のアプリケーションレベルのアドインに追加できます。詳細については、「カスタム作業ウィンドウの概要」を参照してください。

操作ウィンドウの表示

操作ウィンドウは、ActionsPane クラスによって表されます。ドキュメントレベルのプロジェクトを作成するとき、ThisWorkbook クラス (Excel の場合) または ThisDocument クラス (Word の場合) の ActionsPane フィールドをプロジェクトで使用することで、このクラスのインスタンスをコードで使用できます。操作ウィンドウを表示するには、ActionsPane フィールドの Controls プロパティに Windows フォームコントロールを追加します。actions という名前のコントロールを操作ウィンドウに追加するコード例を次に示します。

Me.ActionsPane.Controls.Add(actions)

this.ActionsPane.Controls.Add(actions);

操作ウィンドウは、コントロールを明示的に追加するとすぐに実行時に表示されます。操作ウィンドウが表示された後、ユーザーの操作に応答して、コントロールを動的に追加または削除できます。通常は、ユーザーが初めてドキュメントを開くときに操作ウィンドウが表示されるように、操作ウィンドウを表示するコードを ThisDocument または ThisWorkbook の Startup イベントハンドラに追加します。しかし、ドキュメント内でのユーザーの操作に応答してのみ、操作ウィンドウを表示することもできます。たとえば、ドキュメントのコントロールの Click イベントにコードを追加できます。

操作ウィンドウへの複数のコントロールの追加

操作ウィンドウに複数のコントロールを追加する場合、通常は、対象のコントロールを 1 つのユーザーコントロールにグループ化し、このユーザーコントロールを Controls プロパティに追加します。このプロセスは、次の手順で実行します。

操作ウィンドウコントロール アイテムまたはユーザーコントロール アイテムをプロジェクトに追加して、操作ウィンドウのユーザーインターフェイス (UI: User Interface) を作成します。これらのアイテムのどちらにも、カスタム Windows フォーム UserControl クラスが含まれています。操作ウィンドウコントロール アイテムとユーザーコントロール アイテムは、名前が違うのみで、機能は実質的に同じです。

デザイナを使用するか、またはコードを記述して、Windows フォームコントロールを UserControl に追加します。

メモ :
また、WPF System.Windows.Controls.UserControl を Windows フォーム UserControl に追加することで、WPF コントロールを操作ウィンドウに追加できます。詳細については、「Office ソリューションでの WPF コントロールの使用」を参照してください。

カスタムユーザーコントロールのインスタンスを、プロジェクトの ThisWorkbook クラス (Excel の場合) または ThisDocument クラス (Word の場合) の ActionsPane フィールドに含まれるコントロールに追加します。

このプロセスを詳細に示す例については、「方法 : Word 文書に操作ウィンドウを追加する」および「方法 : Excel ブックに操作ウィンドウを追加する」を参照してください。

操作ウィンドウの非表示

ActionsPane クラスには Hide メソッドと Visible プロパティがありますが、ActionsPane クラス自体のメンバを使用して、ユーザーインターフェイスから操作ウィンドウを削除することはできません。Hide メソッドを呼び出すか、Visible プロパティを false に設定すると、操作ウィンドウのコントロールだけが非表示になり、作業ウィンドウは非表示になりません。

ソリューションの作業ウィンドウを非表示にするには、いくつかの方法があります。

Word の場合、[ドキュメントアクション] 作業ウィンドウを表す TaskPane オブジェクトの Visible プロパティを false に設定します。次のコード例は、プロジェクトの ThisDocument クラスから実行することを前提としています。
```
Me.Application.TaskPanes(Word.WdTaskPanes.wdTaskPaneDocumentActions).Visible = False
```
```
this.Application.TaskPanes[Word.WdTaskPanes.wdTaskPaneDocumentActions].Visible = false;
```
Excel の場合、Application オブジェクトの DisplayDocumentActionTaskPane プロパティを false に設定します。次のコード例は、プロジェクトの ThisWorkbook クラスから実行することを前提としています。
```
Me.Application.DisplayDocumentActionTaskPane = False
```
```
this.Application.DisplayDocumentActionTaskPane = false;
```
Word と Excel の両方において、作業ウィンドウを表すコマンドバーの CommandBar.Visible プロパティを false に設定する方法も使用できます。次のコード例は、プロジェクトの ThisDocument クラスまたは ThisWorkbook クラスから実行することを前提としています。
```
Me.Application.CommandBars("Task Pane").Visible = False
```
```
this.Application.CommandBars["Task Pane"].Visible = false;
```

文書が開かれたときに操作ウィンドウを消去する

操作ウィンドウが表示されている間にドキュメントを保存すると、操作ウィンドウにコントロールが含まれているかどうかに関係なく、ドキュメントを開くたびに操作ウィンドウが表示されます。いつ操作ウィンドウを表示するかを制御するには、ThisDocument または ThisWorkbook の Startup イベントハンドラで ActionsPane フィールドの Clear メソッドを呼び出し、ドキュメントを開いたときに操作ウィンドウが表示されないようにします。

いつ操作ウィンドウが閉じられたかの判定

操作ウィンドウが閉じられたときに発生するイベントはありません。ActionsPane クラスには VisibleChanged イベントがありますが、このイベントは、エンドユーザーによって操作ウィンドウが閉じられたときに発生しません。このイベントは、Hide メソッドを呼び出すか、または Visible プロパティを false に設定することで操作ウィンドウ上のコントロールが非表示になったときに発生します。

操作ウィンドウを閉じた場合、エンドユーザーは、アプリケーションのユーザーインターフェイスで次のいずれかの手順を実行することで、操作ウィンドウを再び表示できます。

Word 2007 または Excel 2007 のユーザーインターフェイスを使用して操作ウィンドウを表示するには

リボンの [表示] タブをクリックします。
[表示/非表示] グループで、[ドキュメントアクション] をクリックします。

Word 2003 または Excel 2003 のユーザーインターフェイスを使用して操作ウィンドウを表示するには

[表示] メニューの [作業ウィンドウ] をクリックします。
[ドキュメントアクション] 作業ウィンドウ以外の作業ウィンドウが表示される場合は、作業ウィンドウの上部にある [その他の作業ウィンドウ] をクリックし、[ドキュメントアクション] をクリックします。

操作ウィンドウイベントのプログラミング

操作ウィンドウに複数のユーザーコントロールを追加し、ユーザーコントロールを表示したり非表示にしたりすることによって、ドキュメント上のイベントに応答するコードを作成できます。XML スキーマ要素をドキュメントにマップすると、XML 要素の 1 つにカーソルが置かれた場合は常に、操作ウィンドウに特定のユーザーコントロールを表示できます。詳細については、「チュートリアル : ユーザーコンテキストに応じた操作ウィンドウの変更」、「方法 : Visual Studio 内で Word 文書にスキーマを割り当てる」、および「方法 : Visual Studio 内でワークシートにスキーマを割り当てる」を参照してください。

ホストコントロール、アプリケーション、またはドキュメントイベントなど、任意のオブジェクトのイベントに応答するコードを作成することもできます。詳細については、「チュートリアル : NamedRange コントロールのイベントのプログラミング 」を参照してください。

操作ウィンドウ上のコントロールへのデータのバインド

操作ウィンドウのコントロールは、Windows フォームのコントロールと同じデータバインディング機能を備えています。データセット、型指定されたデータセット、XML などに、コントロールをバインドできます。詳細については、「データ連結と Windows フォーム」を参照してください。

操作ウィンドウのコントロールとドキュメントのコントロールは、同じデータセットにバインドできます。たとえば、操作ウィンドウのコントロールとワークシートのコントロール間のマスター/詳細リレーションシップを作成できます。詳細については、「チュートリアル : Excel のアクションペインのコントロールへのデータ連結」を参照してください。

操作ウィンドウコントロール内のデータの検証

操作ウィンドウ上のコントロールの Validating イベントハンドラでメッセージボックスを表示する場合、フォーカスをコントロールからメッセージボックスに移動すると、2 度目にイベントが発生することがあります。この問題を回避するには、ErrorProvider コントロールを使用し、検証エラーメッセージを表示します。

ユーザーコントロールのスタック順

複数のユーザーコントロールを使用している場合は、垂直方向または水平方向のドッキングにかかわらず、操作ウィンドウにユーザーコントロールを正しくスタックするコードを作成できます。操作ウィンドウ上のユーザーコントロールを重ねる順序は、StackOrder プロパティの StackStyle 列挙体を使用して設定できます。詳細については、「方法 : アクションペイン上のコントロールのレイアウトを管理する」を参照してください。

StackOrder プロパティには、次の列挙体を指定できます。

スタックスタイル	定義
FromBottom	操作ウィンドウの下からスタックします。
FromLeft	操作ウィンドウの左からスタックします。
FromRight	操作ウィンドウの右からスタックします。
FromTop	操作ウィンドウの上からスタックします。
None	スタック順は定義されません。順序は開発者が制御します。

次のコードでは、操作ウィンドウの上からユーザーコントロールをスタックするように StackOrder プロパティを設定します。

Me.ActionsPane.StackOrder = Microsoft.Office.Tools.StackStyle.FromTop

this.ActionsPane.StackOrder = Microsoft.Office.Tools.StackStyle.FromTop;

コントロールの固定

ユーザーが実行時に操作ウィンドウのサイズを変更する場合に、操作ウィンドウと共にコントロールのサイズを変更できます。コントロールを操作ウィンドウに固定するには、Windows フォームコントロールの Anchor プロパティを使用します。同じように、Windows フォームコントロールをユーザーコントロールに固定することもできます。詳細については、「方法 : Windows フォームにコントロールを固定する」を参照してください。

操作ウィンドウのサイズ変更

ActionsPane は作業ウィンドウに埋め込まれているため、ActionsPane のサイズを直接変更することはできません。しかし、作業ウィンドウを表す CommandBar の Width プロパティを設定すると、プログラムによって作業ウィンドウの幅を変更できます。作業ウィンドウの高さは、作業ウィンドウが水平にドッキングされている場合、または浮動している場合に変更できます。

通常、プログラムによる作業ウィンドウのサイズ変更はお勧めしません。ユーザーが、必要に応じて、作業ウィンドウのサイズを選択できるようにする必要があるためです。ただし、作業ウィンドウの幅を変更する必要がある場合には、次のコードを使用してこのタスクを実現できます。

Me.CommandBars("Task Pane").Width = 200

this.CommandBars["Task Pane"].Width = 200;

操作ウィンドウの移動

ActionsPane は作業ウィンドウに埋め込まれているため、その位置を直接変更することはできません。しかし、作業ウィンドウを表す CommandBar の Position プロパティを設定すると、プログラムによって作業ウィンドウを移動できます。

通常、プログラムによる作業ウィンドウの移動はお勧めしません。ユーザーが、必要に応じて、画面上の作業ウィンドウの位置を選択できるようにする必要があるためです。ただし、作業ウィンドウを特定の位置に移動する必要がある場合は、次のコードを使用してこのタスクを実現できます。

Me.CommandBars("Task Pane").Position = _
    Microsoft.Office.Core.MsoBarPosition.msoBarLeft

this.CommandBars["Task Pane"].Position =
    Microsoft.Office.Core.MsoBarPosition.msoBarLeft;

メモ :
エンドユーザーは、作業ウィンドウの位置を手動でいつでも変更できます。プログラムで指定した位置に作業ウィンドウをドッキングしておくことはできません。ただし、向きの変更を確認し、操作ウィンドウ上のコントロールが正しい方向でスタックされるようにすることは可能です。詳細については、「方法 : アクションペイン上のコントロールのレイアウトを管理する」を参照してください。

エンドユーザーは、作業ウィンドウの位置を手動でいつでも変更できます。プログラムで指定した位置に作業ウィンドウをドッキングしておくことはできません。ただし、向きの変更を確認し、操作ウィンドウ上のコントロールが正しい方向でスタックされるようにすることは可能です。詳細については、「方法 : アクションペイン上のコントロールのレイアウトを管理する」を参照してください。

ActionsPane の Top プロパティおよび Left プロパティを設定しても、その位置は変更されません。これは、ActionsPane オブジェクトが作業ウィンドウに埋め込まれているためです。

作業ウィンドウがドッキングされていない場合、作業ウィンドウを表す CommandBar の Top プロパティおよび Left プロパティを設定できます。次のコードでは、ドッキングが解除された作業ウィンドウをドキュメントの左上隅に移動します。

If Me.CommandBars("Task Pane").Position = _
    Microsoft.Office.Core.MsoBarPosition.msoBarFloating Then

    Me.CommandBars("Task Pane").Top = 0
    Me.CommandBars("Task Pane").Left = 0

End If

if (this.CommandBars["Task Pane"].Position == 
    Microsoft.Office.Core.MsoBarPosition.msoBarLeft)
{
    this.CommandBars["Task Pane"].Top = 0;
    this.CommandBars["Task Pane"].Left = 0;
}