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 ビットマップ リソース (アイコン リソースではない) の ID。 Visual Studio アドインはサテライト DLL を最初に表示されます。 リソースが見つからない場合は、アドイン DLL が検索されます。

• ContextUIGUIDs
  型 : array<Object[]%

  省略可能。 どの環境のコンテキスト (つまり、デバッグ モード、デザイン モードなど) をコマンドに表示するかを決定する GUID。

• vsCommandStatusValue
  型 : Int32

  省略可能。 ContextUIGUIDs のパラメーターを指定し、いずれも、現在アクティブでないときコマンドを無効の状態が非表示または無効であるかどうかを判定します。 「vsCommandDisabledFlags」を参照してください。

• CommandStyleFlags
  型 : Int32

  省略可能。 vsCommandStyle フラグ。特に、vsCommandStylePict、vsCommandStylePictAndText、または vsCommandStyleTextの 1 つが。

• ControlType
  型 : EnvDTE80.vsCommandControlType

  省略可能。 UI 作成時に追加されたコントロールの種類を定義します。

戻り値

型 : Command
作成された、名前付きコマンド。

解説

アドインは、QueryStatus メソッドに応答することによって、ButtonText 名を後で変更できます。 テキストが "#" で始まる場合、文字列の残りの部分は、アドインの登録済みサテライト DLL のリソース ID を表す整数になります。

2 人の既定のコマンド待機状態があります: 既定で有効な状態、および既定のビューの状態。 これらの既定のは (コンポーネントが読み込まれず、IDTCommandTargetを実行しないので) コマンド ハンドラーが検索できない場合に重要です。 コンポーネントが読み込まれ、IDTCommandTargetを実行すると、既定では適用されません。

既定のが使用される 2 種類の興味深いケースがあります:

1. ContextUIGUIDs のパラメーターで UI のコンテキストの GUID を提供します。 この場合、表示は、指定されたコンテキスト GUIDS によって完全に決定されます。 コンテキストがアクティブな場合、コマンドは表示されます。それ以外の場合は非表示になります。 有効な状態は既定で完全に決定されます。 既定では、Visual Studio でコマンドは次に、既定のが無効になっている vsCommandDisabledFlagsGrey を渡すときは常に有効です。 vsCommandDisabledFlagsEnabled 渡す場合、またはこのパラメーターを指定しない場合、既定では有効になっています。

2. ContextUIGUIDs のパラメーターで UI のコンテキストの GUID を提供しません。 この場合、表示は、vsCommandStatusValue または既定のに渡されるフラグに基づいています。 既定のコマンドの表示はなく参照です。 次に、パス vsCommandDisabledFlagsHidden 既定値は非表示になります。 有効な状態は、1 上で、ここに動作と同じです (フラグまたは既定値によって決定されます)。

アドインは、IDTCommandTarget インターフェイスを通じて呼び出し通知を受け取ることができます。 ボタンは、IDTExtensibility2 インターフェイスの OnConnection メソッドを使用して追加できます。

.NET Framework セキュリティ

• 直前の呼び出し元に対する完全な信頼。このメンバーは、部分的に信頼されているコードから使用することはできません。詳細については、「部分信頼コードからのライブラリの使用」を参照してください。

参照

関連項目

Commands2 インターフェイス

EnvDTE80 名前空間