CustomTaskPaneCollection.Remove メソッド (2007 System)

[アーティクル]
08/22/2008

更新 : 2007 年 11 月

指定した CustomTaskPane を CustomTaskPaneCollection から削除します。

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

構文

'宣言
Public Function Remove ( _
    customTaskPane As CustomTaskPane _
) As Boolean
'使用
Dim instance As CustomTaskPaneCollection
Dim customTaskPane As CustomTaskPane
Dim returnValue As Boolean

returnValue = instance.Remove(customTaskPane)

public bool Remove(
    CustomTaskPane customTaskPane
)

パラメータ

customTaskPane
型 : Microsoft.Office.Tools.CustomTaskPane

コレクションから削除する CustomTaskPane。

戻り値

型 : System.Boolean

CustomTaskPane がコレクションから正常に削除された場合は true、指定された CustomTaskPane がコレクションに格納されていない場合は false。

例外

例外	条件
ArgumentNullException	customTaskPane が nullnull 参照 (Visual Basic では Nothing) です。
ObjectDisposedException	Dispose メソッドは既に、CustomTaskPaneCollection で呼び出されています。

解説

アドインでカスタム作業ウィンドウが不要になったときには、Remove メソッドを使用すると、アドインがまだ実行中の状態で、その作業ウィンドウが使用していたリソースをクリーンアップできます。このメソッドを使用すると、指定した CustomTaskPane オブジェクトの Dispose メソッドが自動的に呼び出されます。

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