Commands2.AddNamedCommand2 - метод

Статья
08/11/2011

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

Пространство имен: 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

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
)

abstract AddNamedCommand2 : 
        AddInInstance:AddIn * 
        Name:string * 
        ButtonText:string * 
        Tooltip:string * 
        MSOButton:bool * 
        Bitmap:Object * 
        ContextUIGUIDs:Object[] byref * 
        vsCommandStatusValue:int * 
        CommandStyleFlags:int * 
        ControlType:vsCommandControlType -> Command

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
Обязательный.Указывает, как интерпретируется параметр растрового изображения.
Если значение — true, Bitmap является идентификатором растрового изображения Microsoft Office.
Если MSOButton имеет значение false, Bitmap может иметь одно из следующих значений:
- Bitmap
- Icon
- объект IPicture
- Идентификатор ресурса растрового рисунка 16 x 16 (но не ресурса значка), предоставляемого надстройкой.Visual Studio сначала выполнит поиск во вспомогательной библиотеке DLL надстройки.Если ресурс не найден в этом расположении, будет выполнен поиск библиотеки DLL надстройки.

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

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

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

CommandStyleFlags
Тип: System.Int32
Необязательный.Определяет состояние команды при предоставлении ContextUIGUIDs, если ни один из заданных контекстов в настоящее время не активен.Этот параметр должен обязательно включать vsCommandStatusSupported.Если он также включает vsCommandStatusEnabled, команда будет разрешена.

ControlType
Тип: EnvDTE80.vsCommandControlType

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

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

Заметки

Сведения о получении значений идентификаторов растровых изображений кнопок MSO см. по ссылке Listing Button Faces in the Command Bar for the Microsoft Office System.

Надстройки позже могут изменять имя ButtonText, отвечая на метод QueryStatus. Если текст начинается с "#", то остальная часть строки — это целое число, которое представляет идентификатор ресурса в зарегистрированной вспомогательной библиотеке DLL надстройки.

Параметры ContextUIGUIDs и vsCommandStatusValue используются, когда надстройка не загружена и поэтому не может отвечать на метод QueryStatus. Если ContextUIGUIDs имеет пустое значение, команда включается и остается включенной, пока надстройка не загрузится и не сможет ответить на QueryStatus.

Надстройка может получить уведомление о вызове через интерфейс IDTCommandTarget. Кнопку можно добавить при помощи метода OnConnection интерфейса IDTExtensibility2.

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

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

См. также

Ссылки

Commands2 Интерфейс

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

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