Método ToolBoxItems.Add

Artigo
08/01/2011

Cria um novo item e o adiciona para o caixa de ferramentas.

Namespace: EnvDTE
Assembly: EnvDTE (em EnvDTE.dll)

Sintaxe

'Declaração
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
Obrigatório.Uma seqüência de caracteres que representa a legenda do novo item.

Data
Tipo: System.Object
Obrigatório.Uma variante que representa a seqüência de caracteres, controle ou outro item a ser adicionado para o caixa de ferramentas.

Format
Tipo: EnvDTE.vsToolBoxItemFormat
Opcional.A vsToolBoxItemFormat constante indicando o formato do novo item.

Valor de retorno

Tipo: EnvDTE.ToolBoxItem
A ToolBoxItem objeto.

Comentários

Este método falhará se a ToolBoxItems coleção pertencer a um ToolBoxTab o objeto que foi excluído ou se você tentar adicionar uma guia com um nome que já existe.

Para o Data argumento, Visual C++ os usuários podem passar a IUnknown do IDataObject.

Quando adicionar um conjunto de Format tipo de vsToolBoxItemFormatDotNETComponent, o valor passado para o Data parâmetro pode estar em um dos seguintes formatos:

<AssemblyPath>— Onde "<AssemblyPath>" é um nome de arquivo e caminho apontando para um assembly gerenciado, como C:\Libraries\MyAssembly.dll. Quando você usa esse formato, todas as classes dentro do.DLL são adicionados para o caixa de ferramentas.
<AssemblyNameInTheGAC>— Uma única classe listada como uma referência de assembly qualificado. Classes simples podem ser adicionados como controles, desde que eles são referências a um assembly no cache global de assemblies (GAC), como: WindowControlLibrary1.UserControl1, WindowControlLibrary, Version=1.0.0.0, Culture=neutral, PublicKeyToken=<Your Token>. (Você substituiria <Your Token> com o token de chave pública, que é necessário adicionar o assembly no GAC.)

Exemplos

O exemplo a seguir demonstra como adicionar um documento de texto para o caixa de ferramentas:

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

O exemplo a seguir demonstra como adicionar um.O componente de rede para o caixa de ferramentas usando um caminho para o arquivo. O componente a ser adicionado deve ser um.NET o controle, como um Visual Basic componente de biblioteca de controle do Windows.

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

Segurança do .NET Framework

Confiança total para o chamador imediato. O membro não pode ser usado por código parcialmente confiável. Para obter mais informações, consulte Usando bibliotecas de código parcialmente confiáveis.

Consulte também

Referência

ToolBoxItems Interface

Namespace EnvDTE

Outros recursos

Como: controlar a caixa de ferramentas.

Partilhar via