CustomTaskPaneCollection.Remove メソッド
指定した CustomTaskPane を CustomTaskPaneCollection から削除します。
名前空間: Microsoft.Office.Tools
アセンブリ: Microsoft.Office.Tools.Common (Microsoft.Office.Tools.Common.dll 内)
構文
'宣言
Function Remove ( _
customTaskPane As CustomTaskPane _
) As Boolean
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 Runtime はカスタム作業ウィンドウが使用していたリソースを自動的にクリーンアップします。プロジェクトの ThisAddIn_Shutdown イベント ハンドラーで Remove メソッドを呼び出さないでください。ThisAddIn_Shutdown が呼び出される前に、CustomTaskPane オブジェクトが使用していたリソースが Visual Studio Tools for Office Runtime によってクリーンアップされるため、このメソッドは ObjectDisposedException をスローします。
.NET Framework セキュリティ
- 直前の呼び出し元に対する完全な信頼。このメンバーは、部分的に信頼されているコードから使用することはできません。詳細については、「部分信頼コードからのライブラリの使用」を参照してください。