Commands2.AddNamedCommand2 - метод

Статья
05/17/2015

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

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

Обязательный. AddIn, добавляющего новую команду.

Name
Тип: String

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

ButtonText
Тип: String

Обязательный. Имя, отображаемое в пользовательском интерфейсе для этой команды.

Tooltip
Тип: String

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

MSOButton
Тип: Boolean

Обязательный. Значением должно быть false.

Bitmap
Тип: Object

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

Bitmap может принимать следующие значения:

- Bitmap

- Icon

- объект IPicture

- Идентификатор ресурса растрового рисунка 16 x 16 (но не ресурса значка), предоставляемого надстройкой. Visual Studio сначала ищет в библиотеке DLL вспомогательной надстройки. Если ресурс не найден в этом расположении, будет выполнен поиск библиотеки DLL надстройки.

ContextUIGUIDs
Тип: array<Object[]%

Необязательный. GUID, определяющие, какие контексты среды (то есть режим отладки, режим конструктора, и т д) отображаются команды.

vsCommandStatusValue
Тип: Int32

Необязательный. Определяет, является ли состояние отключенный команды незримое или отключенное при указании параметра ContextUIGUIDs и не активное в данный момент. Дополнительные сведения см. в разделе vsCommandDisabledFlags.

CommandStyleFlags
Тип: Int32

Необязательный. Один из флажков, особенно vsCommandStylePict, vsCommandStylePictAndText или vsCommandStyleText vsCommandStyle.

ControlType
Тип: EnvDTE80.vsCommandControlType

Необязательный. Определяет тип элемента управления, добавляемого при создании пользовательского интерфейса.

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

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

Заметки

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

2 Состояния команды по умолчанию: состояние включена по умолчанию и состояние видимости по умолчанию. Эти состояния по умолчанию важны, если обработчик команды не удается найти, поскольку не загружен (или не реализует компонент IDTCommandTarget). При загрузке и реализует компонент IDTCommandTarget, значения по умолчанию никогда не применяются.

2 Интересных случаи, когда состояния по умолчанию используются:

Предоставить GUID контекста пользовательского интерфейса с помощью параметра ContextUIGUIDs. В этом случае все видимость определена предоставленным контекстом GUIDS. Если контекст активен, команда видима, в противном случае она скрыта. Активное состояние полностью определяется значениями по умолчанию. По умолчанию в Visual Studio команды всегда включена при передаче vsCommandDisabledFlagsGrey, состояние по умолчанию будет запрещено. Если указан vsCommandDisabledFlagsEnabled, а не просто указать этот параметр, состояние по умолчанию включено.
Вы не предоставите GUID контекста пользовательского интерфейса с помощью параметра ContextUIGUIDs. В этом случае видимость основан на флажках передается в vsCommandStatusValue или состояние по умолчанию. Видимость команды по умолчанию в VS в качестве быть видимой. Если передать vsCommandDisabledFlagsHidden здесь, по умолчанию незаметного. Активное состояние это же здесь, его в случае 1 или выше (указанный флажками) ПРОТИВ расширения функциональности).

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

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

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

См. также

Ссылки

Commands2 Интерфейс

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

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