Commands.AddCommandBar メソッド
コマンド バーを作成します。このコマンド バーは保存され、次に環境を起動したときに使用できます。
名前空間: EnvDTE
アセンブリ: EnvDTE (EnvDTE.dll 内)
構文
'宣言
Function AddCommandBar ( _
Name As String, _
Type As vsCommandBarType, _
CommandBarParent As Object, _
Position As Integer _
) As Object
Object AddCommandBar(
string Name,
vsCommandBarType Type,
Object CommandBarParent,
int Position
)
Object^ AddCommandBar(
[InAttribute] String^ Name,
[InAttribute] vsCommandBarType Type,
[InAttribute] Object^ CommandBarParent,
[InAttribute] int Position
)
abstract AddCommandBar :
Name:string *
Type:vsCommandBarType *
CommandBarParent:Object *
Position:int -> Object
function AddCommandBar(
Name : String,
Type : vsCommandBarType,
CommandBarParent : Object,
Position : int
) : Object
パラメーター
- Name
型: System.String
必須。新しいコマンド バーの名前。
- Type
型: EnvDTE.vsCommandBarType
必須。コマンド バーの種類を決定する vsCommandBarType 定数。
- CommandBarParent
型: System.Object
省略可能です。新しいコマンド バーの追加先である Office の CommandBar オブジェクト。ただし、Type が vsCommandBarTypeMenu の場合は必ず指定します。
- Position
型: System.Int32
省略可能です。新しいコマンド バーを配置するための、コマンド バー内のインデックス位置。1 から始まります。
戻り値
型: System.Object
CommandBar オブジェクト。
解説
CommandBar オブジェクトは、Microsoft Office オブジェクト モデルのメンバーです。
このメソッドを使用して追加されたコマンド バーは永続的なコマンド バーです。アドインが読み込まれているかいないかにかかわらず、IDE のすべてのセッションで使用できます。 永続的なコマンド バーが必要な場合にのみ、このメソッドを使用してコマンド バーを追加します。 アドインが初めて読み込まれるときに 1 度だけこのメソッドを呼び出す必要があります。 アドインが実際に読み込まれるときにのみ表示される一時的なコマンド バーが必要な場合、アドインを読み込むときは DTE.CommandBars.Add メソッドを使用する必要があります。また、アドインをアンロードするときは DTE.CommandBars.Remove メソッドを呼び出します。
アドインが読み込まれない場合でも永続的なコマンド バーは表示されるため、アドインのアンインストール時にこのコマンド バーを確実に削除する必要があります。 したがって、MSI を使用してアドインをインストールおよびアンインストールし、カスタム動作をアンインストール プログラムに追加する必要があります。
永続的なコマンド バーおよび一時的なコマンド バーの追加と削除の詳細については、「HOWTO: Adding buttons, commandbars and toolbars to Visual Studio .NET from an add-in」および「HOWTO: Removing commands and UI elements during Visual Studio .NET add-in uninstallation」を参照してください。
例
' Macro code.
Imports Microsoft.VisualStudio.CommandBars
Sub AddCommandBarExample()
' Before running, you must add a reference to the Office
' typelib to gain access to the CommandBar object. Also, for this
' example to work correctly, there should be an add-in available
' in the Visual Studio environment.
Dim cmds As Commands
Dim cmdobj As Command
Dim customin, customout As Object
Dim cmdbarobj As CommandBar
Dim colAddins As AddIns
' Set references.
colAddins = DTE.AddIns()
cmds = DTE.Commands
cmdobj = cmds.Item("File.NewFile")
' Create a toolbar and add the File.NewFile command to it.
cmdbarobj = cmds.AddCommandBar("Mycmdbar", _
vsCommandBarType.vsCommandBarTypeToolbar)
MsgBox("Commandbar name: " & cmdbarobj.Name)
cmdobj = cmds.AddNamedCommand(colAddins.Item(1), "mycommand", _
"mycommand", "tooltip for mycommand", True)
End Sub
.NET Framework セキュリティ
- 直前の呼び出し元に対する完全な信頼。 このメンバーは、部分的に信頼されているコードから使用することはできません。 詳細については、「部分信頼コードからのライブラリの使用」を参照してください。