IDTExtensibility2.OnAddInsUpdate - метод

Статья
08/11/2011

Возникает при загрузке или выгрузке надстройки из интегрированной среды разработки (IDE) Visual Studio.

Пространство имен: Extensibility
Сборка: Extensibility (в Extensibility.dll)

Синтаксис

'Декларация
Sub OnAddInsUpdate ( _
    ByRef custom As Array _
)

void OnAddInsUpdate(
    ref Array custom
)

void OnAddInsUpdate(
    [InAttribute] Array^% custom
)

abstract OnAddInsUpdate : 
        custom:Array byref -> unit

function OnAddInsUpdate(
    custom : Array
)

Параметры

custom
Тип: System.Array%
Пустой массив, который можно использовать для передачи данных среды размещения с их последующим использованием в надстройке.

Заметки

Этот метод наиболее часто используется для обеспечения выполнения зависимостей от других надстроек. Если для корректного запуска надстройки требуется наличие другой надстройки (или программы), с помощью этого метода можно проверить выполнение необходимых условий.

При первой загрузке надстройки в среде в текущем сеансе, а также при нажатии кнопки ОК в окне Диспетчер надстроек возникает событие OnAddInsUpdate. Событие не инициируется, если надстройка была загружена с помощью команды или своего свойства Connected.

Чтобы получить имя измененной надстройки, следует произвести перебор коллекции AddIns и проверить свойство Connected каждой надстройки. Доступ к отдельной надстройке можно получить с помощью идентификатора ProgID или значения индекса (начиная с 1). Если настройка с указанным индексом не существует, возникнет ошибка COMException — "недопустимый индекс". В противном случае возвращается ссылка AddIn.

Примеры

Public Sub OnAddInsUpdate(ByRef custom As Array) 
    Try
        Dim addIn As AddIn = applicationObject.AddIns. _
        Item("MyAddin1.Connect")
        If addInInstance.Connected = True Then
            System.Windows.Forms.MessageBox.Show("This add-in is _
            connected.")
        Else
            System.Windows.Forms.MessageBox.Show("This add-in is not _
            connected.")
        End If
    Catch ex As Runtime.Interop.COMException
        System.Windows.Forms.MessageBox.Show("Not a registered add- _
        in.")
    End Try
End Sub

public void OnAddInsUpdate(ref Array custom)
{
    try
    {
        AddIn addIn = this.dte.addins.item("MyAddin1.Connect");
        if (addInInstance.Connected == true)
        {
            System.Windows.Forms.MessageBox.Show("This add-in is 
            connected.");
        }
        else
        {
            System.Windows.Forms.MessageBox.Show("This add-in is not 
            connected.");
        }
    }

    catch (COMException)
    {
         System.Windows.Forms.MessageBox.Show("Not a registered add-
         in.");
    }
}

Безопасность платформы .NET Framework

Полное доверие для непосредственно вызывающего метода. Этот член не может быть использован частично доверенным кодом. Дополнительные сведения см. в разделе Использование библиотек из не вполне надежного кода.