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
型: EnvDTE.AddIn
必須。AddIn オブジェクトは、新しいコマンドを追加しています。
- Name
型: System.String
必須。新しいコマンドの名前の省略形。AddNamedCommand2 は、先頭に Addins.Progid. を付けて一意の名前を作成します。
- ButtonText
型: System.String
必須。コマンドがアイコンではなく名前で表示されるボタンに連結されている場合に使用する名前。
- Tooltip
型: System.String
必須。新しいコマンドに連結された任意のコントロール上にマウス ポインターを置いたときに表示されるテキスト。
- MSOButton
型: System.Boolean
必ず指定します。ビットマップ パラメーターの解釈方法を示します。
値が true の場合、Bitmap は Microsoft Office ビットマップの ID です。
MSOButton が false の場合、Bitmap は、次のいずれかの値になります。
- Bitmap
- Icon
- IPicture
- アドインが提供する 16 x 16 ビットマップ リソース (アイコン リソースではない) の ID。Visual Studio は、まずアドインのサテライト DLL を参照します。リソースが見つからない場合は、アドイン DLL が検索されます。
- Bitmap
型: System.Object
省略可能です。ボタンに表示するビットマップの ID。「MSOButton」を参照してください。
- ContextUIGUIDs
型: array<System.Object[]%
省略可能です。コマンドを表示する環境コンテキスト (デバッグ モード、デザイン モードなど) を決定する、GUID の SafeArray。詳細については、vsCommandDisabledFlags のトピックを参照してください。
- vsCommandStatusValue
型: System.Int32
省略可能です。ContextUIGUIDs を指定してもどのコンテキストもアクティブにならないときに、コマンドの使用不可状態を非可視にするか淡色表示にするかを決定します。
- CommandStyleFlags
型: System.Int32
省略可能です。ContextUIGUIDs を指定しても、指定したどのコンテキストもアクティブにならない場合に、コマンドの状態を確認します。このパラメーターには、常に vsCommandStatusSupported を含める必要があります。また、vsCommandStatusEnabled も含めると、コマンドが有効になります。
- ControlType
型: EnvDTE80.vsCommandControlType
戻り値
型: EnvDTE.Command
作成された、名前付きコマンド。
解説
MSO ボタンのビットマップ ID 値を取得する方法については、「Microsoft Office System におけるマネージ コード アドインでのカスタム ボタン フェイス」を参照してください。
アドインは、QueryStatus メソッドに応答することによって、ButtonText 名を後で変更できます。 テキストが "#" で始まる場合、文字列の残りの部分は、アドインの登録済みサテライト DLL のリソース ID を表す整数になります。
ContextUIGUIDs パラメーターと vsCommandStatusValue パラメーターは、アドインが読み込まれないために QueryStatus メソッドに応答できない場合に使用します。 ContextUIGUIDs が空の場合、コマンドは、アドインが読み込まれて QueryStatus に応答できるようになるまで使用できます。
アドインは、IDTCommandTarget インターフェイスを通じて呼び出し通知を受け取ることができます。 ボタンは、IDTExtensibility2 インターフェイスの OnConnection メソッドを使用して追加できます。
.NET Framework セキュリティ
- 直前の呼び出し元に対する完全な信頼。 このメンバーは、部分的に信頼されているコードから使用することはできません。 詳細については、「部分信頼コードからのライブラリの使用」を参照してください。