Commands2.AddNamedCommand2 方法

创建命名命令，该命令由环境保存，并且在下次环境启动时（无论是否加载外接程序）可用。

命名空间：  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

  必需。 显示的名称在此命令中的 UI。

• Tooltip
  类型：String

  必需。 当用户将鼠标指针悬停在任何绑定到新命令的控件上时所显示的文本。

• MSOButton
  类型：Boolean

  必需。 必须为 false。

• Bitmap
  类型：Object

  可选。 在按钮上显示的位图的 ID。

  Bitmap可以是如下内容之一：

  - 一个 Bitmap

  - 一个 Icon。

  - 一个 IPicture

  - 由外接程序提供的 16x16 位图资源（但不是图标资源）的 ID。 Visual Studio 首先在外接程序附属 DLL 外观。 如果没有找到资源，则将搜索加载程序 DLL。

• ContextUIGUIDs
  类型：array<Object[]%

  可选。 GUID 确定哪些环境上下文 (即调试模式，设计模式，等等) 显示命令。

• vsCommandStatusValue
  类型：Int32

  可选。 确定命令的禁用条件是不可见或禁用，当您提供一个 ContextUIGUIDs 参数，并且都不是当前活动的。 请参见 vsCommandDisabledFlags。

• CommandStyleFlags
  类型：Int32

  可选。 一 vsCommandStyle 标志、特别是 vsCommandStylePict、vsCommandStylePictAndText或 vsCommandStyleText。

• ControlType
  类型：EnvDTE80.vsCommandControlType

  可选。 定义创建 UI 时添加的控件类型。

返回值

类型：Command
已创建的命名命令。

备注

外接程序以后可以通过响应 QueryStatus 方法来更改 ButtonText 名称。 如果文本以 # 开头，则该字符串的其余部分是一个整数，该整数表示外接程序已注册的附属 DLL 中的资源 ID。

有两个默认值顺序状态：该默认值启用了状态和默认值可见性状态。 这些默认状态很重要，如果找不到命令处理程序 (因为该元素未加载或不实现 IDTCommandTarget)。 如果您的组件加载并实现 IDTCommandTarget，默认值不适用。

可以使用默认状态的两个有趣的情况：

1. 通过 ContextUIGUIDs 参数提供 UI 上下文 GUID。 在所提供的上下文完全由可见性 GUIDS。 如果上下文处于活动状态，则命令可见，否则它隐藏。 默认值完全由启用的状态。 默认情况下在 Visual Studio 命令始终启用，如果通过 vsCommandDisabledFlagsGrey 则默认状态将被禁用。 通过 vsCommandDisabledFlagsEnabled，或者您不提供此参数，则的默认状态有效。

2. 您无法通过 ContextUIGUIDs 参数提供 UI 上下文 GUID。 在可见性根据传递到 vsCommandStatusValue 或默认状态的标志。 默认值命令可见性的是可见的。 如果通过 vsCommandDisabledFlagsHidden 此处，该默认值是不可见的。 启用状态是，以防 1 上相同的此处 (由标志和默认值与行为)。

外接程序可以通过 IDTCommandTarget 接口接收调用通知。 可以使用 IDTExtensibility2 接口的 OnConnection 方法来添加按钮。

.NET Framework 安全性

• 对直接调用方的完全信任。此成员不能由部分信任的代码使用。有关详细信息，请参阅通过部分受信任的代码使用库。

请参阅

参考

Commands2 接口

EnvDTE80 命名空间