Commands.AddCommandBar - метод

Статья
08/11/2011

Создает панель команд, которая сохраняется и становится доступна при следующем запуске среды.

Пространство имен: EnvDTE
Сборка: EnvDTE (в EnvDTE.dll)

Синтаксис

'Декларация
Function AddCommandBar ( _
    Name As String, _
    Type As vsCommandBarType, _
    CommandBarParent As Object, _
    Position As Integer _
) As Object

Object AddCommandBar(
    string Name,
    vsCommandBarType Type,
    Object CommandBarParent,
    int Position
)

Object^ AddCommandBar(
    [InAttribute] String^ Name, 
    [InAttribute] vsCommandBarType Type, 
    [InAttribute] Object^ CommandBarParent, 
    [InAttribute] int Position
)

abstract AddCommandBar : 
        Name:string * 
        Type:vsCommandBarType * 
        CommandBarParent:Object * 
        Position:int -> Object

function AddCommandBar(
    Name : String, 
    Type : vsCommandBarType, 
    CommandBarParent : Object, 
    Position : int
) : Object

Параметры

Name
Тип: System.String
Обязательный.Имя для новой панели команд.

Type
Тип: EnvDTE.vsCommandBarType
Обязательный.Константа из перечисления vsCommandBarType, определяющая тип панели команд.

CommandBarParent
Тип: System.Object
Необязательный.Объект Microsoft Office CommandBar, к которому должна быть добавлена новая панель команд.(Но это требуется, если Type равно vsCommandBarTypeMenu.).

Position
Тип: System.Int32
Необязательный.Индекс позиции, начиная с единицы, в панели команд, с которой будет размещена новая панель команд.

Возвращаемое значение

Тип: System.Object
Объект CommandBar.

Заметки

Объект CommandBar является членом объектной модели Microsoft Office.

Панель команд, добавленная с помощью этого метода, является постоянная панель команд, который доступен в каждой сессии в среде IDE, даже если надстройка не загружена. Следует использовать этот метод для добавления панели команд, только если требуется постоянная панель команд. Этот метод следует вызывать только один раз, при первой загрузке надстройки. Если требуется использовать временную панель команд, которая отображается, только когда надстройка действительно загружается, необходимо при загрузке надстройки использовать метод DTE.CommandBars.Add и при выгрузке надстройки вызвать метод DTE.CommandBars.Remove.

Поскольку постоянная панель команд, появляется даже когда надстройка не загружена, вы должны проверить, что удалили ее при удалении надстройки. Следовательно, для установки и удаления надстройки и добавления пользовательского действия в программу удаления необходимо использовать MSI-файл.

Дополнительные сведения о добавлении и удалении постоянных и временных панелей команд см. в статьях HOWTO: Adding buttons, commandbars and toolbars to Visual Studio .NET from an add-in и HOWTO: Removing commands and UI elements during Visual Studio .NET add-in uninstallation.

Примеры

' Macro code.
Imports Microsoft.VisualStudio.CommandBars
Sub AddCommandBarExample()
   ' Before running, you must add a reference to the Office 
   ' typelib to gain access to the CommandBar object. Also, for this 
   ' example to work correctly, there should be an add-in available 
   ' in the Visual Studio environment.
   Dim cmds As Commands
   Dim cmdobj As Command
   Dim customin, customout As Object
   Dim cmdbarobj As CommandBar
   Dim colAddins As AddIns

   ' Set references.
   colAddins = DTE.AddIns()
   cmds = DTE.Commands
   cmdobj = cmds.Item("File.NewFile")

   ' Create a toolbar and add the File.NewFile command to it.
   cmdbarobj = cmds.AddCommandBar("Mycmdbar", _
   vsCommandBarType.vsCommandBarTypeToolbar)
   MsgBox("Commandbar name: " & cmdbarobj.Name)
   cmdobj = cmds.AddNamedCommand(colAddins.Item(1), "mycommand", _
   "mycommand", "tooltip for mycommand", True)
End Sub

Безопасность платформы .NET Framework

Полное доверие для непосредственно вызывающего метода. Этот член не может быть использован частично доверенным кодом. Дополнительные сведения см. в разделе Использование библиотек из не вполне надежного кода.

См. также

Ссылки

Commands Интерфейс

EnvDTE - пространство имен

Поделиться через