ToolBoxItems.Add - метод
Создает новый элемент и добавляет его в Панель элементов.
Пространство имен: EnvDTE
Сборка: EnvDTE (в EnvDTE.dll)
Синтаксис
'Декларация
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
Параметры
- Name
Тип: System.String
Обязательный.Строка, представляющая заголовок нового элемента.
- Data
Тип: System.Object
Обязательный.Значение variant, представляющее строку, элемент управления или другой элемент, который следует добавить в Панель элементов.
- Format
Тип: EnvDTE.vsToolBoxItemFormat
Необязательный.Константа vsToolBoxItemFormat, указывающая формат для нового элемента.
Возвращаемое значение
Тип: EnvDTE.ToolBoxItem
Объект ToolBoxItem.
Заметки
Этот метод завершится с ошибкой, если коллекция ToolBoxItems принадлежит удаленному объекту ToolBoxTab, а также при попытке добавить вкладку с уже существующим именем.
Для аргумента Data в Visual C++ можно передавать IUnknown интерфейса IDataObject.
При добавлении сборки Format типа vsToolBoxItemFormatDotNETComponent значение, передаваемое Data, может иметь следующие форматы:
<AssemblyPath> — где <AssemblyPath> содержит путь и имя файла, указывающие на управляемую сборку, например C:\Libraries\MyAssembly.dll. При использовании данного формата все классы в DLL-библиотеке добавляются в Панель элементов.
<AssemblyNameInTheGAC> — это отдельный класс, относящийся к ссылке в сборке. Отдельные классы допускается добавлять как элементы управления в том случае, если они являются ссылками на сборку в глобальном кэше сборок (GAC), например: WindowControlLibrary1.UserControl1, WindowControlLibrary, Version=1.0.0.0, Culture=neutral, PublicKeyToken=<Your Token>. (<Your Token> следует заменить на маркер открытого ключа, необходимый для добавления сборки в GAC.)
Примеры
В следующем примере показано добавление текстового документа в Панель элементов:
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
В следующем примере показано добавление компонента .NET в Панель элементов, используя путь к файлу. Добавляемый компонент должен быть элементом управления .NET, например компонентом библиотеки элементов управления Windows в 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
Безопасность платформы .NET Framework
- Полное доверие для непосредственно вызывающего метода. Этот член не может быть использован частично доверенным кодом. Дополнительные сведения см. в разделе Использование библиотек из не вполне надежного кода.