Método CustomTaskPaneCollection.Remove
Remove o especificado CustomTaskPane partir do CustomTaskPaneCollection.
Namespace: Microsoft.Office.Tools
Assembly: Microsoft.Office.Tools.Common (em Microsoft.Office.Tools.Common.dll)
Sintaxe
'Declaração
Function Remove ( _
customTaskPane As CustomTaskPane _
) As Boolean
bool Remove(
CustomTaskPane customTaskPane
)
Parâmetros
- customTaskPane
Tipo: Microsoft.Office.Tools.CustomTaskPane
O CustomTaskPane para remover da coleção.
Valor de retorno
Tipo: System.Boolean
true Se a CustomTaskPane foi removido com êxito da coleção; falseSe a coleção não contiver especificado CustomTaskPane.
Exceções
| Exceção | Condição |
|---|---|
| ArgumentNullException | customTaskPane is nulluma referência nula (Nothing no Visual Basic). |
| ObjectDisposedException | O Dispose() método já foi chamado de CustomTaskPaneCollection. |
Comentários
Se o suplemento não requer mais um painel de tarefas personalizado, você pode usar o Remove método para limpar os recursos usados pelo painel de tarefas enquanto o add-in está ainda em execução. Quando você usa esse método, o Dispose() o método especificado CustomTaskPane automaticamente é chamado de objeto.
O Visual Studio Tools for Office runtime limpa automaticamente os recursos usados pelo painel de tarefas personalizado quando o suplemento é descarregado. Não chame o Remove método na ThisAddIn_Shutdown o manipulador de eventos em seu projeto. Este método lançará um ObjectDisposedException, porque o Visual Studio Tools for Office runtime limpa os recursos usados pela CustomTaskPane objeto antes de ThisAddIn_Shutdown é chamado.
Segurança do .NET Framework
- Confiança total para o chamador imediato. O membro não pode ser usado por código parcialmente confiável. Para obter mais informações, consulte Usando bibliotecas de código parcialmente confiáveis.