IDTExtensibility2.OnConnection メソッド

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

アドインが Visual Studio に読み込まれるたびに発生します。

名前空間: Extensibility
アセンブリ: Extensibility (Extensibility.dll 内)

構文

'宣言
Sub OnConnection ( _
    Application As Object, _
    ConnectMode As ext_ConnectMode, _
    AddInInst As Object, _
    ByRef custom As Array _
)

void OnConnection(
    Object Application,
    ext_ConnectMode ConnectMode,
    Object AddInInst,
    ref Array custom
)

void OnConnection(
    [InAttribute] Object^ Application, 
    [InAttribute] ext_ConnectMode ConnectMode, 
    [InAttribute] Object^ AddInInst, 
    [InAttribute] Array^% custom
)

abstract OnConnection : 
        Application:Object * 
        ConnectMode:ext_ConnectMode * 
        AddInInst:Object * 
        custom:Array byref -> unit

function OnConnection(
    Application : Object, 
    ConnectMode : ext_ConnectMode, 
    AddInInst : Object, 
    custom : Array
)

パラメーター

Application
型: System.Object
統合開発環境 (IDE) のインスタンス DTE への参照です。これは、Visual Studio オートメーションモデルのルートオブジェクトです。

ConnectMode
型: Extensibility.ext_ConnectMode
どのような方法で Visual Studio にアドインが読み込まれたかを示す ext_ConnectMode 列挙値です。

AddInInst
型: System.Object
アドイン独自のインスタンスへの AddIn 参照です。これは、アドインの親コレクションを決定するなど、後の処理で使用できるように格納されます。

custom
型: System.Array%
アドインで使用されるホスト固有のデータを渡すために使用できる空の配列です。

解説

OnConnection はアドインが読み込まれるたびに呼び出されるため、IDTExtensibility2 のメインメソッドとなります。このメソッドはアドインを読み込むときのエントリポイントになるため、アドインの起動時に実行する必要がある任意のコードをこの部分に配置できます。また、他の任意の関数をここから呼び出すこともできます。

例

Public Sub OnConnection(ByVal application As Object, ByVal _
connectMode As ext_ConnectMode, ByVal addInInst As Object, _
ByRef custom As Array) Implements IDTExtensibility2.OnConnection
    applicationObject = CType(application, DTE2)
    addInInstance = CType(addInInst, AddIn)
    MsgBox("Add-in is connected.")
End Sub

public void OnConnection(object application, ext_ConnectMode 
connectMode, object addInInst, ref Array custom)
{
    applicationObject = (DTE2)application;
    addInInstance = (AddIn)addInInst;
    System.Windows.Forms.MessageBox.Show("Add-in has connected.");
}