Share via


CustomTaskPaneCollection.RemoveAt Method

Removes the CustomTaskPane at the specified index of the CustomTaskPaneCollection.

Namespace:  Microsoft.Office.Tools
Assembly:  Microsoft.Office.Tools.Common (in Microsoft.Office.Tools.Common.dll)

Syntax

'Declaration
Sub RemoveAt ( _
    index As Integer _
)
void RemoveAt(
    int index
)

Parameters

Exceptions

Exception Condition
ArgumentOutOfRangeException

The collection does not contain a CustomTaskPane at index.

ObjectDisposedException

The 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 RemoveAt method to clean up resources used by the task pane while the add-in is still running. When you use this method, the Dispose 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 RemoveAt 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.

.NET Framework Security

See Also

Reference

CustomTaskPaneCollection Interface

Microsoft.Office.Tools Namespace