Commands2.AddNamedCommand2 - метод

Статья
11/05/2008

Обновлен: Ноябрь 2007

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

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

Синтаксис

'Декларация
Function AddNamedCommand2 ( _
    AddInInstance As AddIn, _
    Name As String, _
    ButtonText As String, _
    Tooltip As String, _
    MSOButton As Boolean, _
    Bitmap As Object, _
    ByRef ContextUIGUIDs As Object(), _
    vsCommandStatusValue As Integer, _
    CommandStyleFlags As Integer, _
    ControlType As vsCommandControlType _
) As Command
'Применение
Dim instance As Commands2
Dim AddInInstance As AddIn
Dim Name As String
Dim ButtonText As String
Dim Tooltip As String
Dim MSOButton As Boolean
Dim Bitmap As Object
Dim ContextUIGUIDs As Object()
Dim vsCommandStatusValue As Integer
Dim CommandStyleFlags As Integer
Dim ControlType As vsCommandControlType
Dim returnValue As Command

returnValue = instance.AddNamedCommand2(AddInInstance, _
    Name, ButtonText, Tooltip, MSOButton, _
    Bitmap, ContextUIGUIDs, vsCommandStatusValue, _
    CommandStyleFlags, ControlType)

Command AddNamedCommand2(
    AddIn AddInInstance,
    string Name,
    string ButtonText,
    string Tooltip,
    bool MSOButton,
    Object Bitmap,
    ref Object[] ContextUIGUIDs,
    int vsCommandStatusValue,
    int CommandStyleFlags,
    vsCommandControlType ControlType
)

Command^ AddNamedCommand2(
    [InAttribute] AddIn^ AddInInstance, 
    [InAttribute] String^ Name, 
    [InAttribute] String^ ButtonText, 
    [InAttribute] String^ Tooltip, 
    [InAttribute] bool MSOButton, 
    [InAttribute] Object^ Bitmap, 
    [InAttribute] array<Object^>^% ContextUIGUIDs, 
    [InAttribute] int vsCommandStatusValue, 
    [InAttribute] int CommandStyleFlags, 
    [InAttribute] vsCommandControlType ControlType
)

function AddNamedCommand2(
    AddInInstance : AddIn, 
    Name : String, 
    ButtonText : String, 
    Tooltip : String, 
    MSOButton : boolean, 
    Bitmap : Object, 
    ContextUIGUIDs : Object[], 
    vsCommandStatusValue : int, 
    CommandStyleFlags : int, 
    ControlType : vsCommandControlType
) : Command

Параметры

AddInInstance
Тип: EnvDTE.AddIn
Обязательно. Объект AddIn добавляет новую команду.

Name
Тип: System.String
Обязательно. Краткая форма имени новой пользовательской команды. AddNamedCommand2 предваряет "Addins.Progid." для создания уникального имени.

ButtonText
Тип: System.String
Обязательно. Имя, которое используется, если команда имеет привязку к кнопке, которая отображается именем, а не значком.

Tooltip
Тип: System.String
Обязательно. Текст, отображаемый, когда пользователь наводит указатель мыши на любой элемент управления, который имеет привязку к новой команде.

MSOButton
Тип: System.Boolean
Обязательно. Указывает, является ли рисунок кнопки именованной команды рисунком Office. Значение True задает кнопку. Если MSOButton имеет значение False, то Bitmap является идентификатором растрового рисунка 16x16 (но не значка) в библиотеке DLL ресурсов Visual C++, который должен находиться в одной папке с локальным идентификатором языка (1033 для английского, 1049 для русского).

Bitmap
Тип: System.Object
Необязательно. Идентификатор растрового рисунка, который будет отображен на кнопке.

ContextUIGUIDs
Тип: array<System.Object[]%
Необязательно. Массив SafeArray для GUID, который определяет, какой контекст среды (другими словами, режим отладки, режим конструктора и так далее) включает команду. См. раздел vsCommandDisabledFlags.

vsCommandStatusValue
Тип: System.Int32
Необязательно. Определяет, как будет отображаться отключенное состояние команды — серым цветом или же его нельзя будет видеть, когда вводится ContextUIGUIDs и нет ни одной активной команды.

CommandStyleFlags
Тип: System.Int32
Значение из перечисления vsCommandStyle. Управляет визуальным стилем любого элемента пользовательского интерфейса, добавляемого для данной команды.

ControlType
Тип: EnvDTE80.vsCommandControlType
Определяет тип элемента управления, добавляемого при создании пользовательского интерфейса.

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

Тип: EnvDTE.Command
Созданная команда с именем.

Разрешения

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

См. также

Ссылки

Commands2 Интерфейс

Commands2 - члены

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

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