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

  - 增益集所提供之 16 x 16 點陣圖資源 (不是圖示資源) 的識別碼。 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 (Satellite DLL) 中的資源 ID。

有兩個預設命令狀態:預設啟用狀態和預設可視性狀態。 這些預設狀態是很重要的，如果找不到命令處理常式 (因為元件未載入或實作 IDTCommandTarget)。 如果您的元件載入並實作 IDTCommandTarget，預設值會套用。

會使用預設狀態的兩個有趣的情況:

1. 您透過 ContextUIGUIDs 參數提供 UI 內容 GUID。 在這個案例中提供的內容完全由可視性 GUID。 如果內容為使用中，則您的命令是可見，否則會隱藏。 預設值完全由啟用狀態。 預設會在 Visual Studio 命令一定會啟用，如果傳遞 vsCommandDisabledFlagsGrey 您的預設狀態會停用。 如果您傳遞 vsCommandDisabledFlagsEnabled，或者您不提供這個參數，則您的預設狀態為啟用。

2. 您無法透過 ContextUIGUIDs 參數提供 UI 內容 GUID。 在這種情況下可視性根據您傳遞給 vsCommandStatusValue 或預設狀態的旗標。 預設命令可視性設定為永遠可見。 如果您傳遞 vsCommandDisabledFlagsHidden 這裡，預設為不可見。 啟用狀態是它是，以免 1 上面的相同這裡 (由旗標和預設的行為)。

增益集可以透過 IDTCommandTarget 介面接收引動過程告知。 使用 IDTExtensibility2 介面的 OnConnection 方法即可加入按鈕。

.NET Framework 安全性

• 完全信任立即呼叫者。這個成員無法供部分信任的程式碼使用。如需詳細資訊，請參閱從部分受信任程式碼使用程式庫。

請參閱

參考

Commands2 介面

EnvDTE80 命名空間