ToolBoxItem2.Data Property

  • Article

Gets an object containing the IDataObject of the ToolBoxItem on the tool box.

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

Syntax

'Declaration
ReadOnly Property Data As Object

Object Data { get; }

property Object^ Data {
    Object^ get ();
}

abstract Data : Object with get

function get Data () : Object

Property Value

Type: System.Object
An object containing the data a tool box item contains.

Examples

This example selects the second ToolBoxItem2 item and displays its name in a message box. The example also displays assembly information obtained through the ToolBoxItem2.Data object. For more information about how to run this example as an add-in, see How to: Compile and Run the Automation Object Model Code Examples.

Imports EnvDTE
Imports EnvDTE80
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)
    ToolBoxItemDataExample(_applicationObject)
End Sub
Sub ToolBoxItemDataExample(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 Assembly type, obtained through  _
        the Data object:" & vbCr  _
        & tbxItem.Data.GetType.Assembly.ToString())
    Catch ex As System.Exception
        MsgBox("ERROR: " & ex.Message)
    End Try
End Sub

using EnvDTE;
using EnvDTE80;
using System.Windows.Forms;
public void OnConnection(object application, 
ext_ConnectMode connectMode, object addInInst, ref Array custom)
{
    _applicationObject = (DTE2)application;
    _addInInstance = (AddIn)addInInst;
    ToolBoxItemDataExample(_applicationObject);
}
public void ToolBoxItemDataExample(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 Assembly type, 
obtained through the Data object:" + "\n" 
+ tbxItem.Data.GetType().Assembly.ToString());
    }
    catch (Exception ex)
    {
        MessageBox.Show("ERROR: " + ex.Message);
    }
}

.NET Framework Security

See Also

Reference

ToolBoxItem2 Interface

EnvDTE80 Namespace