チュートリアル: リボン XML を使用してカスタム タブを作成します。Walkthrough: Create a custom tab by using Ribbon XML

このチュートリアルを使用してカスタム リボン タブを作成する方法について説明、リボン (XML) 項目。This walkthrough demonstrates how to create a custom Ribbon tab by using the Ribbon (XML) item.

適用されます: ドキュメントにこのトピックの情報が適用されます-レベルのプロジェクトおよび VSTO 追加-次のアプリケーション用のプロジェクトで: Excel;InfoPath 2013 と InfoPath 2010、Outlook;PowerPoint です。プロジェクトです。Visio;単語があります。Applies to: The information in this topic applies to document-level projects and VSTO Add-in projects for the following applications: Excel; InfoPath 2013 and InfoPath 2010; Outlook; PowerPoint; Project; Visio; Word. 詳細については、Office アプリケーションおよびプロジェクトの種類で使用できる機能を参照してください。For more information, see Features available by Office application and project type.

このチュートリアルでは、次の作業について説明します。This walkthrough illustrates the following tasks:

  • ボタンの追加、アドインタブ。アドインタブがリボン XML ファイルで定義されている既定のタブ。Adding buttons to the Add-Ins tab. The Add-Ins tab is the default tab that is defined in the Ribbon XML file.

  • Microsoft Office Word を自動化するボタンを使用して、アドインタブ。Automating Microsoft Office Word by using the buttons on the Add-Ins tab.

Note

次の手順で参照している Visual Studio ユーザー インターフェイス要素の一部は、お使いのコンピューターでは名前や場所が異なる場合があります。Your computer might show different names or locations for some of the Visual Studio user interface elements in the following instructions. これらの要素は、使用している Visual Studio のエディションや独自の設定によって決まります。The Visual Studio edition that you have and the settings that you use determine these elements. 詳細については、「Visual Studio IDE のカスタマイズ」を参照してください。For more information, see Personalize the Visual Studio IDE.

必須コンポーネントPrerequisites

このチュートリアルを実行するには、次のコンポーネントが必要です。You need the following components to complete this walkthrough:

プロジェクトの作成Create the project

まず、Word VSTO アドイン プロジェクトを作成します。The first step is to create a Word VSTO Add-in project. カスタマイズ後で、アドインこのドキュメントのタブ。You will later customize the Add-Ins tab of this document.

新しいプロジェクトを作成するにはTo create a new project

  1. 作成、 Word アドインという名前のプロジェクトMyRibbonAddInします。Create a Word Add-in project with the name MyRibbonAddIn.

    詳細については、「方法 :Visual Studio で Office プロジェクトを作成する方法」を参照してください。For more information, see How to: Create Office projects in Visual Studio.

    Visual StudioVisual Studio 表示されます、 ThisAddIn.csまたはThisAddIn.vbコード ファイルのほか、 MyRibbonAddInプロジェクトをソリューション エクスプ ローラーします。opens the ThisAddIn.cs or ThisAddIn.vb code file and adds the MyRibbonAddIn project to Solution Explorer.

VSTO [アドイン] タブを作成します。Create the VSTO Add-ins tab

作成する、アドイン タブで、追加、リボン (XML) 項目をプロジェクトにします。To create the Add-Ins tab, add a Ribbon (XML) item to your project. このチュートリアルの後半で、このタブにボタンを追加します。Later in this walkthrough, you will add some buttons to this tab.

[アドイン] タブを作成するにはTo create the Add-ins tab

  1. [プロジェクト] メニューの [新しい項目の追加] をクリックします。On the Project menu, click Add New Item.

  2. 新しい項目の追加ダイアログ ボックスで、リボン (XML) します。In the Add New Item dialog box, select Ribbon (XML).

  3. 新しいリボンの名前を " MyRibbon" に変更し、 [追加] をクリックします。Change the name of the new Ribbon to MyRibbon, and click Add.

    MyRibbon.csまたはMyRibbon.vbファイルは、デザイナーが開きます。The MyRibbon.cs or MyRibbon.vb file opens in the designer. XML ファイルは、というMyRibbon.xmlもプロジェクトに追加されます。An XML file that is named MyRibbon.xml is also added to your project.

  4. ソリューション エクスプ ローラーを右クリックしてThisAddin.csまたはThisAddin.vb、 をクリックし、コードの表示します。In Solution Explorer, right-click ThisAddin.cs or ThisAddin.vb, and then click View Code.

  5. 次のコードを ThisAddin クラスに追加します。Add the following code to the ThisAddin class. このコードは、CreateRibbonExtensibilityObject メソッドをオーバーライドし、Office アプリケーションにリボン XML クラスを返します。This code overrides the CreateRibbonExtensibilityObject method and returns the Ribbon XML class to the Office application.

    protected override Microsoft.Office.Core.IRibbonExtensibility CreateRibbonExtensibilityObject()
    {
        return new MyRibbon();
    }
    
    Protected Overrides Function CreateRibbonExtensibilityObject() As  _
    Microsoft.Office.Core.IRibbonExtensibility
        Return New MyRibbon()
    End Function
    
  6. ソリューション エクスプ ローラーを右クリックし、 MyRibbonAddInプロジェクトをクリックしてビルドします。In Solution Explorer, right-click the MyRibbonAddIn project and then click Build. プロジェクトのビルドでエラーが発生しないことを確認します。Verify that the project builds without errors.

[アドイン] タブにボタンを追加します。Add buttons to the Add-ins tab

この VSTO アドインの目的は、定型句や特定の表を作業中のドキュメントに追加する手段をユーザーに提供することです。The goal for this VSTO Add-in is to give users a way to add boilerplate text and a specific table to the active document. ユーザー インターフェイスを提供する 2 つのボタンを追加、アドイン タブをリボン XML ファイルを変更します。To provide the user interface, add two buttons to the Add-Ins tab by modifying the Ribbon XML file. このチュートリアルの後半で、これらのボタンのコールバック メソッドを定義します。Later in this walkthrough, you will define callback methods for the buttons. リボン XML ファイルの詳細については、リボン XMLを参照してください。For more information about the Ribbon XML file, see Ribbon XML.

[アドイン] タブにボタンを追加するにはTo add buttons to the Add-ins tab

  1. ソリューション エクスプ ローラー、右クリックしてMyRibbon.xml順にクリックしますオープンします。In Solution Explorer, right-click MyRibbon.xml and then click Open.

  2. 内容を置き換える、タブを次の XML 要素。Replace the contents of the tab element with the following XML. この XML に既定のコントロール グループのラベルを変更するコンテンツ、というラベルが付いた 2 つの新しいボタンを追加およびInsert TextInsert Tableします。This XML changes the label of the default control group to Content, and it adds two new buttons with the labels Insert Text and Insert Table.

    <tab idMso="TabAddIns">
        <group id="ContentGroup" label="Content">
            <button id="textButton" label="Insert Text"
                 screentip="Text" onAction="OnTextButton"
                 supertip="Inserts text at the cursor location."/>
            <button id="tableButton" label="Insert Table"
                 screentip="Table" onAction="OnTableButton"
                 supertip="Inserts a table at the cursor location."/>
        </group>
    </tab>
    

ボタンを使用して、ドキュメントを自動化します。Automate the document by using the buttons

追加する必要がありますonActionのコールバック メソッド、 Insert TextInsert Tableにユーザーがクリックしたときにアクションを実行するボタン。You must add onAction callback methods for the Insert Text and Insert Table buttons to perform actions when the user clicks them. リボン コントロールのコールバック メソッドの詳細については、リボン XMLを参照してください。For more information about callback methods for Ribbon controls, see Ribbon XML.

ボタンのコールバック メソッドを追加するにはTo add callback methods for the buttons

  1. ソリューション エクスプ ローラーを右クリックしてMyRibbon.csまたはMyRibbon.vb、 をクリックし、オープンします。In Solution Explorer, right-click MyRibbon.cs or MyRibbon.vb, and then click Open.

  2. 先頭に次のコードを追加、 MyRibbon.csまたはMyRibbon.vbファイル。Add the following code to the top of the MyRibbon.cs or MyRibbon.vb file. このコードによって、Microsoft.Office.Interop.Word 名前空間のエイリアスが作成されます。This code creates an alias for the Microsoft.Office.Interop.Word namespace.

    using Word = Microsoft.Office.Interop.Word;
    
    Imports Word = Microsoft.Office.Interop.Word
    
  3. MyRibbon クラスに次のメソッドを追加します。Add the following method to the MyRibbon class. これは、コールバック メソッド、 Insert Textカーソルの現在の場所にアクティブなドキュメントに文字列を追加するボタン。This is a callback method for the Insert Text button that adds a string to the active document at the current location of the cursor.

    public void OnTextButton(Office.IRibbonControl control)
    {
        Word.Range currentRange = Globals.ThisAddIn.Application.Selection.Range;
        currentRange.Text = "This text was added by the Ribbon.";
    }
    
    Public Sub OnTextButton(ByVal control As Office.IRibbonControl)
        Dim currentRange As Word.Range = Globals.ThisAddIn.Application.Selection.Range
        currentRange.Text = "This text was added by the Ribbon."
    End Sub
    
  4. MyRibbon クラスに次のメソッドを追加します。Add the following method to the MyRibbon class. これは、コールバック メソッド、 Insert Tableカーソルの現在の場所にアクティブなドキュメントにテーブルを追加するボタン。This is a callback method for the Insert Table button that adds a table to the active document at the current location of the cursor.

    public void OnTableButton(Office.IRibbonControl control)
    {
        object missing = System.Type.Missing;
        Word.Range currentRange = Globals.ThisAddIn.Application.Selection.Range;
        Word.Table newTable = Globals.ThisAddIn.Application.ActiveDocument.Tables.Add(
        currentRange, 3, 4, ref missing, ref missing);
    
        // Get all of the borders except for the diagonal borders.
        Word.Border[] borders = new Word.Border[6];
        borders[0] = newTable.Borders[Word.WdBorderType.wdBorderLeft];
        borders[1] = newTable.Borders[Word.WdBorderType.wdBorderRight];
        borders[2] = newTable.Borders[Word.WdBorderType.wdBorderTop];
        borders[3] = newTable.Borders[Word.WdBorderType.wdBorderBottom];
        borders[4] = newTable.Borders[Word.WdBorderType.wdBorderHorizontal];
        borders[5] = newTable.Borders[Word.WdBorderType.wdBorderVertical];
    
        // Format each of the borders.
        foreach (Word.Border border in borders)
        {
            border.LineStyle = Word.WdLineStyle.wdLineStyleSingle;
            border.Color = Word.WdColor.wdColorBlue;
        }
    }
    
    Public Sub OnTableButton(ByVal control As Office.IRibbonControl)
        Dim missing As Object = System.Type.Missing
    
        Dim currentRange As Word.Range = Globals.ThisAddIn.Application.Selection.Range
        Dim newTable As Word.Table = Globals.ThisAddIn.Application.ActiveDocument.Tables.Add( _
                   currentRange, 3, 4)
    
        ' Get all of the borders except for the diagonal borders.
        Dim borders() As Word.Border = New Word.Border(6) {}
        borders(0) = newTable.Borders(Word.WdBorderType.wdBorderLeft)
        borders(1) = newTable.Borders(Word.WdBorderType.wdBorderRight)
        borders(2) = newTable.Borders(Word.WdBorderType.wdBorderTop)
        borders(3) = newTable.Borders(Word.WdBorderType.wdBorderBottom)
        borders(4) = newTable.Borders(Word.WdBorderType.wdBorderHorizontal)
        borders(5) = newTable.Borders(Word.WdBorderType.wdBorderVertical)
    
        ' Format each of the borders.
        For Each border As Word.Border In borders
            border.LineStyle = Word.WdLineStyle.wdLineStyleSingle
            border.Color = Word.WdColor.wdColorBlue
        Next
    End Sub
    

VSTO アドインのテストTesting the VSTO Add-in

実行中のプロジェクト、word およびという名前のタブアドインリボンが表示されます。When you run the project, Word opens and the tab named Add-Ins appears on the ribbon. をクリックして、 Insert Textテーブルの挿入ボタン、アドインタブ コードをテストします。Click the Insert Text and Insert Table buttons on the Add-Ins tab to test the code.

VSTO アドインをテストするにはTo test your VSTO Add-in

  1. キーを押してF5プロジェクトを実行します。Press F5 to run your project.

  2. いることを確認、アドインタブは、リボンに表示されます。Confirm that the Add-Ins tab is visible on the ribbon.

  3. [アドイン] タブをクリックします。Click the Add-Ins tab.

  4. いることを確認、コンテンツグループがリボンに表示されます。Confirm that the Content group is visible on the ribbon.

  5. をクリックして、 Insert Textボタン、コンテンツグループ。Click the Insert Text button in the Content group.

    ドキュメント内のカーソルの現在位置に文字列が追加されます。A string is added to the document at the current location of the cursor.

  6. をクリックして、 Insert Tableボタン、コンテンツグループ。Click the Insert Table button in the Content group.

    ドキュメント内のカーソルの現在位置に表が追加されます。A table is added to the document at the current location of the cursor.

次の手順Next steps

Office UI をカスタマイズする方法の詳細については、次のトピックで説明します。You can learn more about how to customize the Office UI from these topics:

  • 別の Office アプリケーションのリボンをカスタマイズします。Customize the ribbon of a different Office application. リボンのカスタマイズをサポートするアプリケーションの詳細については、リボンの概要を参照してください。For more information about the applications that support customizing the ribbon, see Ribbon overview.

  • Office アプリケーションのリボンをカスタマイズするには、リボン デザイナーを使用します。Customize the ribbon of an Office application by using the Ribbon Designer. 詳細については、「 Ribbon Designer」を参照してください。For more information, see Ribbon Designer.

  • カスタム操作ウィンドウを作成する。Create a custom actions pane. 詳細については、操作ウィンドウの概要を参照してください。For more information, see Actions pane overview.

  • Outlook フォーム領域を使用して Microsoft Office Outlook の UI をカスタマイズする。Customize the UI of Microsoft Office Outlook by using Outlook Form Regions. 詳細については、「チュートリアル:Outlook フォーム領域をデザインします。For more information, see Walkthrough: Design an Outlook form region.

関連項目See also