Solution2.DTE Property

  • Article

Gets the top-level extensibility object.

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

Syntax

'Declaration
ReadOnly Property DTE As DTE

DTE DTE { get; }

property DTE^ DTE {
    DTE^ get ();
}

abstract DTE : DTE with get

function get DTE () : DTE

Property Value

Type: EnvDTE.DTE
A DTE object.

Remarks

In Visual Studio, the DTE object is the root of the automation model, which other object models often call "Application".

Examples

For information on how to run this add-in code, see How to: Compile and Run the Automation Object Model Code Examples.

The following example finds and displays the caption of the active window in an open solution.

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)

   SolutionDTEExample(_applicationObject)
End Sub

Sub SolutionDTEExample(ByVal dte As DTE2)
    ' This add-in displays the caption of the active window,
    ' obtained through the DTE object. Open a solution in 
    ' Visual Studio before running this example.
    Try
        Dim soln As Solution2 = CType(_applicationObject.Solution, _
        Solution2)
        MsgBox _
        ("The caption of the active window, obtained through the DTE object, is: " & _
        vbCr & soln.DTE.ActiveWindow.Caption)
    Catch ex As System.Exception
        MsgBox(ex.ToString)
    End Try
End Sub

//you will need to add this reference to your project as well
using System.Windows.Forms;
public void OnConnection(object application,
 Extensibility.ext_ConnectMode connectMode, object addInInst,
 ref System.Array custom)
{
    _applicationObject = (DTE2)application;
    _addInInstance = (AddIn)addInInst;
    // Pass the applicationObject member variable to the code example.
    SolutionCount((DTE2)_applicationObject);
}
public void SolutionCount(DTE2 dte)
{
    // This add-in displays the caption of the active window,
    // obtained through the DTE object. Open a solution in 
    // Visual Studio before running this example.
    Try
    {
        Solution2 soln = (Solution2)_applicationObject.Solution;
        MessageBox.Show
("The caption of the active window, obtained through the DTE object, is: "
 + soln.DTE.ActiveWindow.Caption);
    }
    catch(SystemException ex)
    {
        MessageBox.Show("ERROR: " + ex);
    }
}

.NET Framework Security

See Also

Reference

Solution2 Interface

EnvDTE80 Namespace

Other Resources

How to: Compile and Run the Automation Object Model Code Examples