CustomTaskPaneCollection.Remove, méthode
Supprime le CustomTaskPane spécifié de la CustomTaskPaneCollection.
Espace de noms : Microsoft.Office.Tools
Assembly : Microsoft.Office.Tools.Common (dans Microsoft.Office.Tools.Common.dll)
Syntaxe
'Déclaration
Function Remove ( _
customTaskPane As CustomTaskPane _
) As Boolean
bool Remove(
CustomTaskPane customTaskPane
)
Paramètres
- customTaskPane
Type : Microsoft.Office.Tools.CustomTaskPane
CustomTaskPane à supprimer de la collection.
Valeur de retour
Type : System.Boolean
true si le CustomTaskPane a été correctement supprimé de la collection ; false si la collection ne contient pas le CustomTaskPane spécifié.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentNullException | customTaskPane a la valeur nullune référence null (Nothing en Visual Basic). |
| ObjectDisposedException | La méthode Dispose a déjà été appelée dans la CustomTaskPaneCollection. |
Notes
Si votre complément ne requiert plus un volet de tâches personnalisé, vous pouvez utiliser la méthode Remove pour nettoyer les ressources utilisées par le volet de tâches alors que le complément est en cours d'exécution. Lorsque vous utilisez cette méthode, la méthode Dispose de l'objet CustomTaskPane spécifié est appelée automatiquement.
Le Visual Studio Tools pour Office Runtime nettoie automatiquement les ressources utilisées par le volet de tâches personnalisé lorsque le complément est déchargé. N'appelez pas la méthode Remove dans le gestionnaire d'événements ThisAddIn_Shutdown dans votre projet. Cette méthode lève une exception ObjectDisposedException car Visual Studio Tools pour Office Runtime nettoie les ressources utilisées par l'objet CustomTaskPane avant l'appel de ThisAddIn_Shutdown.
Sécurité .NET Framework
- Confiance totale accordée à l'appelant immédiat. Ce membre ne peut pas être utilisé par du code d'un niveau de confiance partiel. Pour plus d'informations, consultez Utilisation de bibliothèques à partir de code d'un niveau de confiance partiel.