ToolBoxItem2.DTE Property

Reference

Definition

Namespace:: EnvDTE80

Assembly:: EnvDTE80.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets the top-level extensibility object.

public:
 property EnvDTE::DTE ^ DTE { EnvDTE::DTE ^ get(); };

public:
 property EnvDTE::DTE ^ DTE { EnvDTE::DTE ^ get(); };

[System.Runtime.InteropServices.DispId(2)]
public EnvDTE.DTE DTE { [System.Runtime.InteropServices.DispId(2)] get; }

[<System.Runtime.InteropServices.DispId(2)>]
[<get: System.Runtime.InteropServices.DispId(2)>]
member this.DTE : EnvDTE.DTE

Public ReadOnly Property DTE As DTE

Property Value

DTE

A DTE object.

Implements

DTE

Attributes: DispIdAttribute

Examples

This example selects the second ToolBoxItem2 item and displays its name in a message box. The example also displays the caption for the active window, obtained through the ToolBoxItem2.DTE object.

Imports EnvDTE  
Imports EnvDTE80  
Sub ToolBoxItemDTEExample(ByVal dte As DTE2)  
    Dim tlBox As ToolBox  
    Dim tbxTabs As ToolBoxTabs  
    Dim tbxTab As ToolBoxTab2  
    Dim tbxItem As ToolBoxItem2  
    ' Before running this example, open a Windows Application project.  
    Try  
        ' Create an object reference to the IDE's ToolBox object and  
        ' its tabs.  
        tlBox = CType(_applicationObject.Windows.Item _  
         (Constants.vsWindowKindToolbox).Object, ToolBox)  
        tbxTabs = tlBox.ToolBoxTabs  
        ' Select the second Toolbox tab.  
        tbxTab = CType(tbxTabs.Item(2), ToolBoxTab2)  
        tbxTab.Activate()  
        MsgBox("Toolbox tab name: " & tbxTab.Name)  
        tbxItem = CType(tbxTab.ToolBoxItems.Item(2), ToolBoxItem2)  
        MsgBox("Toolbox item name: " & tbxItem.Name)  
        MsgBox(tbxItem.Name & "'s active window caption, _  
        obtained through the DTE object:" & vbCr  _  
        & tbxItem.DTE.ActiveWindow.Caption)  
    Catch ex As System.Exception  
        MsgBox("ERROR: " & ex.Message)  
    End Try  
End Sub

using EnvDTE;  
using EnvDTE80;  
using System.Windows.Forms;  
public void ToolBoxItemDTExample(DTE2 dte)  
{  
    ToolBox tlBox;  
    ToolBoxTabs tbxTabs;  
    ToolBoxTab2 tbxTab;  
    ToolBoxItem2 tbxItem;  
    // Before running this example, open a Windows Application project  
    // and select Toolbox from the View menu.  
    try  
    {  
        // Create an object reference to the IDE's ToolBox object  
        // and its tabs.  
        tlBox = (ToolBox)_applicationObject.Windows.Item  
(Constants.vsWindowKindToolbox).Object;  
        tbxTabs = tlBox.ToolBoxTabs;  
        // Select the second Toolbox tab.  
        tbxTab = (ToolBoxTab2)tbxTabs.Item(2);  
        tbxTab.Activate();  
        MessageBox.Show("Toolbox tab name: " + tbxTab.Name);  
        tbxItem = (ToolBoxItem2)tbxTab.ToolBoxItems.Item(2);  
        MessageBox.Show("Toolbox item name: " + tbxItem.Name);  
        MessageBox.Show(tbxItem.Name + "'s active window caption,  
 obtained through the DTE object:" + "\n"   
+ tbxItem.DTE.ActiveWindow.Caption);  
    }  
    catch (Exception ex)  
    {  
        MessageBox.Show("ERROR: " + ex.Message);  
    }  
}

Remarks

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

Applies to

Share via