CustomTaskPaneCollection.Remove - метод
Удаляет заданный объект CustomTaskPane из CustomTaskPaneCollection.
Пространство имен: Microsoft.Office.Tools
Сборка: Microsoft.Office.Tools.Common (в Microsoft.Office.Tools.Common.dll)
Синтаксис
'Декларация
Function Remove ( _
customTaskPane As CustomTaskPane _
) As Boolean
bool Remove(
CustomTaskPane customTaskPane
)
Параметры
- customTaskPane
Тип: Microsoft.Office.Tools.CustomTaskPane
Объект CustomTaskPane для удаления из коллекции.
Возвращаемое значение
Тип: System.Boolean
Значение true, если CustomTaskPane была успешно удалена из коллекции; или false, если коллекция не содержит заданную CustomTaskPane.
Исключения
Исключение | Условие |
---|---|
ArgumentNullException | Параметр customTaskPane имеет значение nullпустая ссылка (Nothing в Visual Basic). |
ObjectDisposedException | Метод Dispose() уже вызван для CustomTaskPaneCollection. |
Заметки
Если для надстройки больше не требуется настраиваемая область задач, то можно использовать метод Remove для очистки ресурсов, используемых настраиваемой областью задач в ходе работы надстройки. Если используется этот метод, то автоматически вызывается метод Dispose() указанных объектов CustomTaskPane.
Среда выполнения Среда выполнения Visual Studio Tools for Office автоматически очищает ресурсы, которые использовались настраиваемой областью задач, при выгрузке надстройки. Не следует вызывать метод Remove в обработчике события ThisAddIn_Shutdown проекта. Этот метод создает исключение ObjectDisposedException, поскольку среда выполнения Среда выполнения Visual Studio Tools for Office очищает ресурсы, используемые объектом CustomTaskPane, до вызова ThisAddIn_Shutdown.
Безопасность платформы .NET Framework
- Полное доверие для непосредственно вызывающего метода. Этот член не может быть использован частично доверенным кодом. Дополнительные сведения см. в разделе Использование библиотек из не вполне надежного кода.