Freigeben über


IDTExtensibility2.OnConnection Method

Occurs whenever an add-in is loaded into Visual Studio.

Namespace:  Extensibility
Assembly:  Extensibility (in Extensibility.dll)

Syntax

'Declaration
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
)

Parameters

  • Application
    Type: System.Object

    A reference to an instance of the integrated development environment (IDE), DTE, which is the root object of the Visual Studio automation model.

  • AddInInst
    Type: System.Object

    An AddIn reference to the add-in's own instance. This is stored for later use, such as determining the parent collection for the add-in.

  • custom
    Type: System.Array%

    An empty array that you can use to pass host-specific data for use in the add-in.

Remarks

OnConnection is the main method for IDTExtensibility2, because it is called every time an add-in is loaded. It is the entry point for an add-in when it is loaded, so you can put any code here (or call any another function) that you want to run when the add-in starts.

Examples

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.");
}

.NET Framework Security

See Also

Reference

IDTExtensibility2 Interface

Extensibility Namespace

IDTExtensibility2

OnDisconnection

OnAddInsUpdate

OnBeginShutdown

OnStartupComplete

Other Resources

How to: Create an Add-In