This topic has not yet been rated - Rate this topic

IDTExtensibility2.OnConnection Method

Visual Studio 2012

Other Versions

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

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

Syntax

C++

JScript

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

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.

ConnectMode: Type: Extensibility.ext_ConnectMode
An ext_ConnectMode enumeration value that indicates the way the add-in was loaded into Visual Studio.

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 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

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Reference

IDTExtensibility2 Interface

Extensibility Namespace

Other Resources

How to: Create an Add-In

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)