IDTExtensibility2.OnAddInsUpdate メソッド

[アーティクル]
08/09/2011

Visual Studio 統合開発環境 (IDE: Integrated Development Environment) からアドインの読み込みまたはアンロードが行われるたびに発生します。

名前空間: 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%
アドインで使用されるホスト固有のデータを渡すために使用できる空の配列です。

解説

このメソッドは、他のアドインへの依存関係を適用するために頻繁に使用されます。つまり、アドインを正常に実行するために別のアドイン (または他のプログラム) の存在が必要な場合、このメソッドでステータスをチェックできます。

アドインは、そのセッションで初めて環境に読み込まれたとき、および [アドインマネージャー] の [OK] がクリックされるたびに 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.");
    }
}