方法 : Office メニューをプログラムで作成する

更新 : 2007 年 11 月

対象
このトピックの情報は、指定された Visual Studio Tools for Office プロジェクトおよび Microsoft Office のバージョンにのみ適用されます。 プロジェクトの種類 ドキュメント レベルのプロジェクト アプリケーション レベルのプロジェクト Microsoft Office のバージョン Microsoft Office 2003 詳細については、「アプリケーションおよびプロジェクトの種類別の使用可能な機能」を参照してください。

この例では、Microsoft Office Excel 2003 のメニュー バーに "New Menu" というメニューを作成します。この新しいメニューは [ヘルプ] メニューの前に配置されます。このメニューには、1 つのメニュー コマンドがあります。そのメニュー コマンドをクリックすると、Sheet1 のセルにテキストが挿入されます。

Microsoft Office Word 2003 のユーザー インターフェイスをカスタマイズする例については、「方法 : Office ツール バーをプログラムで作成する」および「チュートリアル : ブックマークのショートカット メニューの作成」を参照してください。

ThisWorkbook クラスに次のコードを追加します。

メモ :
イベント ハンドラを追加する場合は、コントロールの Tag プロパティを設定する必要があります。Office では、特定の CommandBarControl のイベント ハンドラを追跡するために Tag プロパティが使用されます。Tag プロパティが空の場合、イベントは正しく処理されません。

メモ :
メニュー変数は、それらが呼び出されるメソッドの内部ではなく、クラス レベルで宣言します。そうすることにより、アプリケーションが実行している間、メニュー変数がスコープ内に維持されます。このようにしないと、項目はガベージ コレクションによって削除され、イベント ハンドラのコードは実行を停止します。

使用例

' Declare the menu variable at the class level.
Private WithEvents menuCommand As Office.CommandBarButton
Private menuTag As String = "A unique tag"


' Call AddMenu from the Startup event of ThisWorkbook.
Private Sub ThisWorkbook_Startup(ByVal sender As Object, ByVal e As System.EventArgs) _
    Handles Me.Startup

    CheckIfMenuBarExists()
    AddMenuBar()
End Sub


' If the menu already exists, remove it.
Private Sub CheckIfMenuBarExists()
    Try
        Dim foundMenu As Office.CommandBarPopup = _
            Me.Application.CommandBars.ActiveMenuBar.FindControl( _
                Office.MsoControlType.msoControlPopup, System.Type.Missing, menuTag, True, True)

        If foundMenu IsNot Nothing Then
            foundMenu.Delete(True)
        End If

    Catch ex As Exception
        MessageBox.Show(ex.Message)
    End Try
End Sub


' Create the menu, if it does not exist.
Private Sub AddMenuBar()

    Try
        Dim menuBar As Office.CommandBar = Application.comm.CommandBars.ActiveMenuBar
        Dim menuCaption As String = "Ne&w Menu"

        If menuBar IsNot Nothing Then
            Dim cmdBarControl As Office.CommandBarPopup = Nothing
            Dim controlCount As Integer = menuBar.Controls.Count

            ' Add the new menu.
            cmdBarControl = CType(menuBar.Controls.Add( _
                Type:=Office.MsoControlType.msoControlPopup, Before:=controlCount, Temporary:=True),  _
                Office.CommandBarPopup)

            cmdBarControl.Caption = menuCaption

            ' Add the menu command.
            menuCommand = CType(cmdBarControl.Controls.Add( _
                Type:=Office.MsoControlType.msoControlButton, Temporary:=True),  _
                Office.CommandBarButton)

            With menuCommand
                .Caption = "&New Menu Command"
                .Tag = "NewMenuCommand"
                .FaceId = 65
            End With
        End If

    Catch ex As Exception
        MessageBox.Show(ex.Message)
    End Try
End Sub


' Add text to cell A1 when the menu is clicked.
Private Sub menuCommand_Click(ByVal Ctrl As Microsoft.Office.Core.CommandBarButton, _
    ByRef CancelDefault As Boolean) Handles menuCommand.Click

    Globals.Sheet1.Range("A1").Value2 = "The menu command was clicked."
End Sub

// Declare the menu variable at the class level.
private Office.CommandBarButton menuCommand;
private string menuTag = "A unique tag";


// Call AddMenu from the Startup event of ThisWorkbook.
private void ThisWorkbook_Startup(object sender, System.EventArgs e)
{
    CheckIfMenuBarExists();
    AddMenuBar();
}


// If the menu already exists, remove it.
private void CheckIfMenuBarExists()
{
    try 
    {
        Office.CommandBarPopup foundMenu = (Office.CommandBarPopup)
            this.Application.CommandBars.ActiveMenuBar.FindControl(
            Office.MsoControlType.msoControlPopup, System.Type.Missing, menuTag, true, true);

        if (foundMenu != null)
        {
            foundMenu.Delete(true);
        }
    }
    catch (Exception ex)
    {
        MessageBox.Show(ex.Message);
    }
}


// Create the menu, if it does not exist.
private void AddMenuBar()
{
    try
    {
        Office.CommandBarPopup cmdBarControl = null;
        Office.CommandBar menubar = (Office.CommandBar)Application.CommandBars.ActiveMenuBar;
        int controlCount = menubar.Controls.Count;
        string menuCaption = "&New Menu";

        // Add the menu.
        cmdBarControl = (Office.CommandBarPopup)menubar.Controls.Add(
            Office.MsoControlType.msoControlPopup, missing, missing, controlCount, true);

        if (cmdBarControl != null)
        {
            cmdBarControl.Caption = menuCaption;

            // Add the menu command.
            menuCommand = (Office.CommandBarButton)cmdBarControl.Controls.Add(
                Office.MsoControlType.msoControlButton, missing, missing, missing, true);

            menuCommand.Caption = "&New Menu Command";
            menuCommand.Tag = "NewMenuCommand";
            menuCommand.FaceId = 65;

            menuCommand.Click += new Microsoft.Office.Core._CommandBarButtonEvents_ClickEventHandler(
                menuCommand_Click);
        }
    }
    catch (Exception e)
    {
        MessageBox.Show(e.Message);
    }
}


// Add text to cell A1 when the menu is clicked.
private void menuCommand_Click(Microsoft.Office.Core.CommandBarButton Ctrl, ref bool CancelDefault)
{
    Globals.Sheet1.Range["A1", missing].Value2 = "The menu command was clicked.";
}

参照

処理手順

方法 : Office ツール バーをプログラムで作成する

チュートリアル : ブックマークのショートカット メニューの作成

概念

Office UI のカスタマイズ

Office ソリューションの省略可能なパラメータについて