CustomTaskPaneCollection.Remove(CustomTaskPane) Method

Definition

Removes the specified CustomTaskPane from the CustomTaskPaneCollection.

public:
 bool Remove(Microsoft::Office::Tools::CustomTaskPane ^ customTaskPane);
public bool Remove (Microsoft.Office.Tools.CustomTaskPane customTaskPane);
abstract member Remove : Microsoft.Office.Tools.CustomTaskPane -> bool
Public Function Remove (customTaskPane As CustomTaskPane) As Boolean

Parameters

customTaskPane
CustomTaskPane

The CustomTaskPane to remove from the collection.

Returns

true if the CustomTaskPane was successfully removed from the collection; false if the collection does not contain the specified CustomTaskPane.

Exceptions

customTaskPane is null.

The Microsoft.Office.Tools.CustomTaskPaneCollection.Dispose method has already been called on the CustomTaskPaneCollection.

Remarks

If your add-in no longer requires a custom task pane, you can use the Remove method to clean up resources used by the task pane while the add-in is still running. When you use this method, the <xref:Microsoft.Office.Tools.CustomTaskPane.Dispose%2A> method of the specified CustomTaskPane object is automatically called.

The Visual Studio Tools for Office runtime automatically cleans up resources used by the custom task pane when the add-in is unloaded. Do not call the Remove method in the ThisAddIn_Shutdown event handler in your project. This method will throw an ObjectDisposedException, because the Visual Studio Tools for Office runtime cleans up resources used by the CustomTaskPane object before ThisAddIn_Shutdown is called.

Applies to