Compartir a través de

ToolBoxItems.Add (Método)

  • Artículo

Crea un nuevo elemento y lo agrega al Cuadro de herramientas.

Espacio de nombres:  EnvDTE
Ensamblado:  EnvDTE (en EnvDTE.dll)

Sintaxis

'Declaración
Function Add ( _
    Name As String, _
    Data As Object, _
    Format As vsToolBoxItemFormat _
) As ToolBoxItem

ToolBoxItem Add(
    string Name,
    Object Data,
    vsToolBoxItemFormat Format
)

ToolBoxItem^ Add(
    [InAttribute] String^ Name, 
    [InAttribute] Object^ Data, 
    [InAttribute] vsToolBoxItemFormat Format
)

abstract Add : 
        Name:string * 
        Data:Object * 
        Format:vsToolBoxItemFormat -> ToolBoxItem 

function Add(
    Name : String, 
    Data : Object, 
    Format : vsToolBoxItemFormat
) : ToolBoxItem

Parámetros

  • Name
    Tipo: System.String
    Obligatorio.Cadena que representa la leyenda del nuevo elemento.
  • Data
    Tipo: System.Object
    Obligatorio.Tipo Variant que representa la cadena, el control o cualquier otro elemento que se vaya a agregar al Cuadro de herramientas.

Valor devuelto

Tipo: EnvDTE.ToolBoxItem
Objeto ToolBoxItem.

Comentarios

En este método se produce un error si la colección ToolBoxItems pertenece a un objeto ToolBoxTab eliminado o si se intenta agregar una ficha con un nombre que ya existe.

Para el argumento Data, los usuarios de Visual C++ pueden pasar la interfaz IUnknown de IDataObject.

Cuando se agrega un ensamblado del tipo Format vsToolBoxItemFormatDotNETComponent, el valor que se pasa al parámetro Data puede tener cualquiera de los siguientes formatos:

  • <AssemblyPath>. Donde "<AssemblyPath>" corresponde a una ruta de acceso y un nombre de archivo que señalan a un ensamblado administrado, como C:\Libraries\MyAssembly.dll. Cuando se usa este formato, todas las clases de la .DLL se agregan al Cuadro de herramientas.

  • <AssemblyNameInTheGAC>. Una clase única aparece como una referencia calificada con el nombre de ensamblado. Las clases únicas pueden agregarse como controles en la medida en que son referencias a un ensamblado que está en la caché global de ensamblados (GAC), como: WindowControlLibrary1.UserControl1, WindowControlLibrary, Version=1.0.0.0, Culture=neutral, PublicKeyToken=<Your Token>. (Puede reemplazar <Your Token> por su símbolo de clave pública, que es necesario para agregar el ensamblado a la GAC.)

Ejemplos

En el siguiente ejemplo se muestra cómo agregar un documento de texto al Cuadro de herramientas:

Sub ToolBoxAddExample1()
    ' This adds a Text item to the first tab of the ToolBox.
    ' Define the variables and create an object reference to the IDE's  
    ' ToolBox object.
    Dim win As Window = DTE.Windows.Item(Constants.vsWindowKindToolbox)
    Dim tlbox As ToolBox = win.Object
    Dim tbxTabs As ToolBoxTabs

    ' Create an object reference to the ToolBoxTabs object.
    tbxTabs = tlbox.ToolBoxTabs

    ' Add a new Text item to the first tab in the ToolBox.
    tbxTabs.Item(1).ToolBoxItems.Add("New Text Item", "Some text to _
    add to the document.", vsToolBoxItemFormat.vsToolBoxItemFormatText)
End Sub

En el siguiente ejemplo se muestra cómo agregar un componente .NET al Cuadro de herramientas mediante una ruta al archivo. El componente que va a agregar debe ser un control de .NET, como un componente de la Biblioteca de controles de Windows de Visual Basic.

Sub ToolBoxItemAddExample2()
    Try
        Dim tlBox As ToolBox
        tlBox = CType(DTE.Windows.Item(Constants. _
        vsWindowKindToolbox).Object, EnvDTE.ToolBox)
        ' Create a new tab called "My Controls."
        Dim tlBoxTab As ToolBoxTab = tlBox.ToolBoxTabs. _
        Add("My Controls")
        ' Set focus to the new Toolbox tab.
        tlBoxTab.Activate()
        ' Add a .NET control as a new control in the new ToolBox tab. 
        ' The constant "vsToolBoxItemFormatDotNETComponent" alerts the 
        ' ToolBox to the type of control you are adding.
        tlBoxTab.ToolBoxItems.Add("MyDotNetControl", _
        "C:\Libraries\ADotNetControl.dll(", _
        vsToolBoxItemFormat.vsToolBoxItemFormatDotNETComponent)
    Catch ex As System.Exception
        ' Display any errors that occur.
        MsgBox("ERROR: " & ex.Message)
    End Try
End Sub

Seguridad de .NET Framework

Vea también

Referencia

ToolBoxItems Interfaz

EnvDTE (Espacio de nombres)

Otros recursos

Cómo: Controlar el Cuadro de herramientas