Método CustomTaskPaneCollection.Remove
Remove CustomTaskPane especificado de 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
CustomTaskPane a remoção da coleção.
Valor de retorno
Tipo: System.Boolean
true se CustomTaskPane foi removido com êxito de coleção; false se a coleção não contém CustomTaskPaneespecificado.
Exceções
| Exceção | Condição |
|---|---|
| ArgumentNullException | customTaskPane é nulluma referência nula (Nothing no Visual Basic). |
| ObjectDisposedException | O método de Dispose tiver sido chamado já CustomTaskPaneCollection. |
Comentários
Se o suplemento não requer um painel de tarefa personalizada, você pode usar o método de Remove para limpar os recursos usados pelo painel de tarefas quando o suplemento ainda executar.Quando você usa esse método, o método de Dispose do objeto especificado de CustomTaskPane é chamado automaticamente.
Visual Studio Tools for Office Runtime faz automaticamente os recursos usados pelo painel de tarefa personalizada quando o suplemento é descarregado.Não chame o método de Remove no manipulador de eventos de ThisAddIn_Shutdown em seu projeto.Este método irá acionar ObjectDisposedException, porque Visual Studio Tools for Office Runtime limpa os recursos usados pelo objeto de CustomTaskPane antes que ThisAddIn_Shutdown seja 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.