Share via


ToolBoxTab2.UniqueID Property

Sets or gets a unique ID for the specified tab.

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

Syntax

'Declaration
Property UniqueID As String
string UniqueID { get; set; }
property String^ UniqueID {
    String^ get ();
    void set (String^ value);
}
abstract UniqueID : string with get, set
function get UniqueID () : String 
function set UniqueID (value : String)

Property Value

Type: String
A unique ID.

Examples

This example selects and activates the first ToolBoxTab2 item and displays its name and unique name in a message box. 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)
    ToolBoxTabUniqueIDExample(_applicationObject)
End Sub
Sub ToolBoxTabUniqueIDExample(ByVal dte As DTE2)
    Dim tlBox As ToolBox
    Dim tbxTabs As ToolBoxTabs
    Dim tbxTab As ToolBoxTab2
    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 first Toolbox tab.
        tbxTab = CType(tbxTabs.Item(1), ToolBoxTab2)
        MsgBox(tbxTab.Name)
        tbxTab.Activate()
        MsgBox("The unique ID of the Toolbox tab: "  _
        & tbxTab.Name & " is " & tbxTab.UniqueID)
    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;
    ToolBoxTabUniqueIDExample(_applicationObject);
}
public void ToolBoxTabUniqueIDExample(DTE2 dte)
{
    ToolBox tlBox;
    ToolBoxTabs tbxTabs;
    ToolBoxTab2 tbxTab;
    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 first Toolbox tab.
        tbxTab = (ToolBoxTab2)tbxTabs.Item(1);
        MessageBox.Show("The name of the selected Toolbox tab is: " 
+ tbxTab.Name);
        tbxTab.Activate();
        MessageBox.Show("The unique ID of the Toolbox tab: " 
+ tbxTab.Name + " is " + tbxTab.UniqueID);
    }
    catch (Exception ex)
    {
        MessageBox.Show("ERROR: " + ex.Message);
    }
}

.NET Framework Security

See Also

Reference

ToolBoxTab2 Interface

EnvDTE80 Namespace