CustomTaskPaneCollection インターフェイス

[アーティクル]
05/14/2013

Microsoft Office アプリケーションのカスタム作業ウィンドウのコレクションを表します。

名前空間: Microsoft.Office.Tools
アセンブリ: Microsoft.Office.Tools.Common (Microsoft.Office.Tools.Common.dll 内)

構文

'宣言
<GuidAttribute("c3a84bf1-e95b-4d23-952d-59e35673958e")> _
Public Interface CustomTaskPaneCollection _
    Inherits IEnumerable(Of CustomTaskPane), IEnumerable, IDisposable

[GuidAttribute("c3a84bf1-e95b-4d23-952d-59e35673958e")]
public interface CustomTaskPaneCollection : IEnumerable<CustomTaskPane>, 
    IEnumerable, IDisposable

CustomTaskPaneCollection 型で公開されるメンバーは以下のとおりです。

プロパティ

	名前	説明
	Count	現在の CustomTaskPaneCollection 内のCustomTaskPane オブジェクトの数を取得します。
	Item	指定したインデックス位置にある CustomTaskPane を取得します。

このページのトップへ

メソッド

	名前	説明
	Add(UserControl, String)	新しい CustomTaskPane を作成し、現在の CustomTaskPaneCollection に追加します。カスタム作業ウィンドウは、指定された UserControl に基づき、指定されたタイトルがあります。
	Add(UserControl, String, Object)	新しい CustomTaskPane を作成し、現在の CustomTaskPaneCollection に追加します。カスタム作業ウィンドウは、指定された UserControl に基づき、指定されたタイトルがあり、指定されたアプリケーションウィンドウに関連付けられています。
	BeginInit	インフラストラクチャ。
	Dispose	アンマネージリソースの解放およびリセットに関連付けられているアプリケーション定義のタスクを実行します。 (IDisposable から継承されます。)
	EndInit	インフラストラクチャ。
	GetEnumerator	コレクションを反復処理する列挙子を返します。 (IEnumerable<CustomTaskPane> から継承されます。)
	Remove	指定した CustomTaskPane を CustomTaskPaneCollection から削除します。
	RemoveAt	CustomTaskPaneCollection の指定されたインデックスにある CustomTaskPane を削除します。

このページのトップへ

解説

アプリケーションに対してカスタム作業ウィンドウの追加または削除を行ったり、既存のカスタム作業ウィンドウにアクセスしたりするには、アプリケーションレベルのアドインの CustomTaskPaneCollection オブジェクトを使用します。CustomTaskPaneCollection オブジェクトにアクセスするには、アドインプロジェクト内の ThisAddIn クラスの CustomTaskPanes フィールドを使用します。詳細については、「アプリケーションレベルのアドインのプログラミング」を参照してください。

作業ウィンドウは、アプリケーションウィンドウのいずれかの端に通常ドッキングされているユーザーインターフェイスパネルです。カスタム作業ウィンドウの作成方法の詳細については、「カスタム作業ウィンドウ」を参照してください。

[!メモ]

これは、Visual Studio Tools for Office Runtime によって実装されたインターフェイスです。コードに実装されるものではありません。詳細については、「Visual Studio Tools for Office Runtime の概要」を参照してください。

使用方法

ここでは、.NET Framework 4 および .NET Framework 4.5 を対象とする Office プロジェクトで使用される型のバージョンについて説明します。.NET Framework 3.5 を対象とするプロジェクトでは、この型のメンバーが異なること、およびこのコード例が動作しないことがあります。.NET Framework 3.5 を対象とするプロジェクトの型の詳細については、Visual Studio 2008 ドキュメントの参照セクション https://go.microsoft.com/fwlink/?LinkId=160658 を参照してください。

例

次のコード例は、Add(UserControl, String) メソッドを使用してカスタム作業ウィンドウを作成する方法を示します。また、このコード例では、CustomTaskPane オブジェクトのプロパティを使用してカスタム作業ウィンドウの既定の外観を変更します。このコード例は、CustomTaskPane のトピックで取り上げているコード例の一部分です。

Private myUserControl1 As MyUserControl
Private WithEvents myCustomTaskPane As Microsoft.Office.Tools.CustomTaskPane

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

    myUserControl1 = New MyUserControl()
    myCustomTaskPane = Me.CustomTaskPanes.Add(myUserControl1, "New Task Pane")

    With myCustomTaskPane
        .DockPosition = Office.MsoCTPDockPosition.msoCTPDockPositionFloating
        .Height = 500
        .Width = 500
        .DockPosition = Office.MsoCTPDockPosition.msoCTPDockPositionRight
        .Width = 300
        .Visible = True
    End With
End Sub

private MyUserControl myUserControl1;
private Microsoft.Office.Tools.CustomTaskPane myCustomTaskPane;

private void ThisAddIn_Startup(object sender, System.EventArgs e)
{
    myUserControl1 = new MyUserControl();
    myCustomTaskPane = this.CustomTaskPanes.Add(myUserControl1,
        "New Task Pane");

    myCustomTaskPane.DockPosition =
        Office.MsoCTPDockPosition.msoCTPDockPositionFloating;
    myCustomTaskPane.Height = 500;
    myCustomTaskPane.Width = 500;

    myCustomTaskPane.DockPosition =
        Office.MsoCTPDockPosition.msoCTPDockPositionRight;
    myCustomTaskPane.Width = 300;

    myCustomTaskPane.Visible = true;
    myCustomTaskPane.DockPositionChanged +=
        new EventHandler(myCustomTaskPane_DockPositionChanged);
}