方法: ショートカットメニューにアドインを表示する

[アーティクル]
02/21/2013

Visual Studio オートメーションモデルは、アドインコマンドをトップレベルメニュー ([ツール] メニューなど) に配置したり、コマンドをショートカットメニューやサブメニューに登録したりすることを簡単に実現できるように設計されています。

ただし、そのためには、Microsoft Visual Studio の Command Bar オブジェクトモデルを使用して、登録先のショートカットメニューやサブメニューを明示的に定義する必要があります。その上で、Visual Studio の AddControl メソッドを呼び出すことになります。

ショートカットメニューは、Visual Studio が元から備えているメニューと同じ感覚で使用できます。これらのショートカットメニューには、ドロップダウンメニューの下向きの矢印をポイントするか、統合開発環境 (IDE: Integrated Development Environment) で項目をダブルクリックするとアクセスできます。

コマンドをショートカットメニュー (または任意のメニューまたはツールバー) に追加するには、最初にそのコマンド名を知っている必要があります。[ツール] メニューの [オプション] ダイアログボックスに表示される [キーボード] ノードで確認できます。

アドインコマンドを [タスク一覧] のショートカットメニューに追加する方法を次の手順に示します。

[!メモ]

実際に画面に表示されるダイアログボックスとメニューコマンドは、アクティブな設定またはエディションによっては、ヘルプの説明と異なる場合があります。ここに記載されている手順は、全般的な開発設定が適用されているものとして記述されています。設定を変更するには、[ツール] メニューの [設定のインポートとエクスポート] をクリックします。詳細については、「Visual Studio の設定」を参照してください。

アドインコマンドをショートカットメニューに追加するには

[ファイル] メニューの [新規作成] をポイントし、[プロジェクト] をクリックします。
[新しいプロジェクト] ダイアログボックスの [その他のプロジェクトの種類] を展開します。次に、[機能拡張] をクリックして、[テンプレート] ペインの [Visual Studio アドイン] をクリックします。

アドインに ContextCmd という名前を付け、[OK] をクリックすると、Visual Studio アドインウィザードが起動します。
[アドイン用のコマンドバー UI を作成しますか?] ボックスをオンにして、アドインにユーザーインターフェイス (UI) を作成するオプションを選択します。

これにより、OnConnection メソッドに UI 用のコードが追加されます。さらに、ユーザーがアドインコマンドをクリックしたときのイベントを処理するための Exec メソッドと、アドインのステータス情報を提供する QueryStatus メソッドが追加されます。

このコードを次のコードを使って置き換えます。

Imports System
Imports Microsoft.VisualStudio.CommandBars
Imports Extensibility
Imports EnvDTE
Imports EnvDTE80

Public Class Connect

    Implements IDTExtensibility2
    Implements IDTCommandTarget

    Dim _applicationObject As DTE2
    Dim _addInInstance As AddIn

    Dim cmdBarCtl As CommandBarControl

    Public Sub New()
    End Sub

    Public Sub OnConnection(ByVal application As Object, ByVal _
      connectMode As ext_ConnectMode, ByVal addInInst As Object, _
      ByRef custom As Array) Implements _
      IDTExtensibility2.OnConnection
        Dim cmd As Command
        Dim cmdBar As CommandBar

        _applicationObject = CType(application, DTE2)
        _addInInstance = CType(addInInst, AddIn)

        Try
            If CType(ext_ConnectMode.ext_cm_AfterStartup Or _
              ext_ConnectMode.ext_cm_Startup, Boolean) Then
                ' If the command does not exist, add it.
                If cmd Is Nothing Then
                    cmd = _applicationObject.Commands. _
                      AddNamedCommand(_addInInstance, _
                      "newCmd", "newCmd", "Runs the add-in.", _
                      True, 59, Nothing, _
                      vsCommandStatus.vsCommandStatusSupported _
                      Or vsCommandStatus.vsCommandStatusEnabled)
                End If

                ' Reference the Task List shortcut menu.
                cmdBar = CType(_applicationObject. _
                  CommandBars.Item("Task List"), _
                  Microsoft.VisualStudio.CommandBars.CommandBar)

                ' Add a command to the Task List's shortcut menu.
                cmdBarCtl = CType(cmd.AddControl(cmdBar, _
                  cmdBar.Controls.Count + 1), _
                  Microsoft.VisualStudio.CommandBars. _
                  CommandBarControl)
                cmdBarCtl.Caption = "A New Command"
            End If
        Catch e As System.Exception
            System.Windows.Forms.MessageBox.Show(e.ToString)
        End Try
    End Sub

    Public Sub OnDisconnection(ByVal disconnectMode As _
      ext_DisconnectMode, ByRef custom As Array) Implements _
      IDTExtensibility2.OnDisconnection
        Try
            ' Delete the command bar control from the 
               ' shortcut menu.
            If Not (cmdBarCtl Is Nothing) Then
                cmdBarCtl.Delete()
            End If
        Catch e As System.Exception
            System.Windows.Forms.MessageBox.Show(e.ToString)
        End Try
    End Sub

    Public Sub OnAddInsUpdate(ByRef custom As Array) Implements _
      IDTExtensibility2.OnAddInsUpdate
    End Sub

    Public Sub OnStartupComplete(ByRef custom As Array) Implements _
      IDTExtensibility2.OnStartupComplete
    End Sub

    Public Sub OnBeginShutdown(ByRef custom As Array) Implements _
      IDTExtensibility2.OnBeginShutdown
    End Sub

    Public Sub QueryStatus(ByVal commandName As String, ByVal _
      neededText As vsCommandStatusTextWanted, ByRef status As _
      vsCommandStatus, ByRef commandText As Object) Implements _
      IDTCommandTarget.QueryStatus
        If commandName = "ContextCmd.Connect.newCmd" Then
            status = CType(vsCommandStatus.vsCommandStatusEnabled _
              + vsCommandStatus.vsCommandStatusSupported, _
              vsCommandStatus)
        Else
            status = vsCommandStatus.vsCommandStatusUnsupported
        End If
    End Sub

    Public Sub Exec(ByVal commandName As String, ByVal _
      executeOption As vsCommandExecOption, ByRef varIn As _
      Object, ByRef varOut As Object, ByRef handled As Boolean) _
      Implements IDTCommandTarget.Exec
        handled = False
        If executeOption = vsCommandExecOption. _
          vsCommandExecOptionDoDefault Then
            If commandName = "ContextCmd.Connect.newCmd" Then
                handled = True
                System.Windows.Forms.MessageBox.Show("Add-in _
                  running...")
            End If
        End If
    End Sub
End Class

Exec プロシージャに、コマンドがクリックされたときに実行するコードを追加します。
アドインをビルドして実行します。
[表示] メニューの [タスク一覧] をクリックして、[タスク一覧] を表示します。
[ツール] メニューの [アドインマネージャー] をクリックします。
[アドインマネージャー] で、ContextCmd アドインに対応するチェックボックスをオンにして、アドインをアクティブにします。
[タスク一覧] を右クリックします。

[ContextCmd] アドインコマンドがショートカットメニューに表示されます。

参照

次の方法で共有

方法: ショートカットメニューにアドインを表示する

アドインコマンドをショートカットメニューに追加するには

参照

処理手順

関連項目

概念

その他の技術情報

その他のリソース

次の方法で共有

方法: ショートカット メニューにアドインを表示する

アドイン コマンドをショートカット メニューに追加するには

参照

処理手順

関連項目

概念

その他の技術情報

その他のリソース

方法: ショートカットメニューにアドインを表示する

アドインコマンドをショートカットメニューに追加するには