Office Fluent リボンのカスタマイズに管理対象 COM アドインを使用する

[アーティクル]
04/07/2023

Microsoft Office スイートで Microsoft Office Fluent ユーザーインターフェイスのリボンコンポーネントを使用すると、ユーザーは Office アプリケーションを柔軟に操作できます。リボン拡張機能 (RibbonX) では、単純なテキストベースの宣言型 XML マークアップを使用して、リボンを作成およびカスタマイズします。

このトピックのコード例は、開かれるドキュメントに関係なく、Office アプリケーションのリボンをカスタマイズする方法を示しています。以下の手順では、管理された COM アドインを使用してアプリケーションレベルのカスタマイズを作成し、Microsoft Visual C# を使用して Microsoft Visual Studio 2012 のアドインを作成します。このプロジェクトでは、カスタムタブ、カスタムグループ、およびカスタムボタンをリボンに追加します。手順を完了するには、以下のタスクを実行します。

XML カスタマイズファイルを作成します。
C# を使用して、マネージ COM アドインプロジェクトを Microsoft Visual Studio 2012 に作成します。
XML カスタマイズファイルを埋め込みリソースとしてプロジェクトに追加します。
IRibbonExtensibility インターフェイスを実装します。
ボタンがクリックされたときに起動するコールバックメソッドを作成します。
プロジェクトのビルド、インストール、テストを行います。

XML カスタマイズファイルを作成する

この手順では、カスタムコンポーネントをリボンに追加するファイルを作成します。

テキストエディターで、以下の XML マークアップを追加します。

 <customUI xmlns="http://schemas.microsoft.com/office/2006/01/customui"> 
   <ribbon> 
     <tabs> 
       <tab id="CustomTab" label="My Tab"> 
         <group id="SampleGroup" label="Sample Group"> 
           <button id="Button" label="Insert Company Name" size="large" onAction="InsertCompanyName" /> 
         </group > 
       </tab> 
     </tabs> 
   </ribbon> 
 </customUI>

ファイルを閉じて、customUI.xml という名前を付けて保存します。

マネージ COM アドインプロジェクトを作成する

この手順では、COM アドイン C# プロジェクトを Microsoft Visual Studio 2012 に作成します。

Microsoft Visual Studio 2012 を起動します。
[ファイル] メニューの [新しいプロジェクト] をクリックします。
[新しいプロジェクト] ダイアログボックスの [プロジェクトの種類] の下で、[その他のプロジェクト] を展開し、[機能拡張プロジェクト] をクリックして、[共有アドイン] をダブルクリックします。
プロジェクトに名前を付けます。この例では、RibbonXSampleCS と入力します。
共有アドインウィザードの最初の画面で、[次へ] をクリックします。
[Visual C# を使用してアドインを作成] を選択し、[次へ] をクリックします。
[Microsoft Word] 以外のすべての選択を解除して、[次へ] をクリックします。
アドインの名前と説明を入力し、[次へ] をクリックします。
[アドインオプションを選択します] 画面で、[ホストアプリケーションの読み込み時にアドインを読み込む] をオンにして、[次へ] をクリックします。
[完了] をクリックしてウィザードを終了します。

プロジェクトへの外部参照を追加する

この手順では、Word プライマリ相互運用機能アセンブリおよびタイプライブラリへの参照を追加します。

ソリューションエクスプローラーで [参照] を右クリックし、[参照の追加] をクリックします。

注:

[参照] フォルダーが表示されない場合は、[プロジェクト] メニューを選択し、[すべてのファイルを表示] を選択します。
[.NET] タブを下にスクロールし、Ctrl キーを押して [Microsoft.Office.Interop.Word] を選択します。
[COM] タブを下にスクロールし、[Microsoft Office 15.0 Object Library] (または使用している Office のバージョンに適したライブラリ) を選択して、[OK] をクリックします。

次の名前空間参照をプロジェクトに追加します (まだ存在しない場合は、 名前空間 行のすぐ下)。

 using System.Reflection; 
 using Microsoft.Office.Core; 
 using System.IO; 
 using System.Xml; 
 using Extensibility; 
 using System.Runtime.InteropServices; 
 using MSword = Microsoft.Office.Interop.Word;

カスタマイズファイルを埋め込みリソースとして追加する

この手順では、XML カスタマイズファイルをプロジェクトの埋め込みリソースとして追加します。

ソリューションエクスプローラーで [RibbonXSampleCS] を右クリックし、[追加] をポイントして、[既存の項目] をクリックします。
作成した customUI.xml ファイルに移動し、ファイルを選択して、[追加] をクリックします。
ソリューションエクスプローラーで [customUI.xml] を右クリックして、[プロパティ] を選択します。
[プロパティ] ウィンドウで [ビルドアクション] を選択し、[埋め込まれたリソース] まで下にスクロールします。

IRibbonExtensibility インターフェイスを実装する

この手順では、実行時に Word アプリケーションへの参照を作成するためのコードを Extensibility.IDTExtensibility2::OnConnection に追加します。また、IRibbonExtensibility インターフェイスの唯一のメンバーである GetCustomUI を実装します。

ソリューションエクスプローラーで、[Connect.cs] を右クリックし、[コードの表示] をクリックします。
Connect メソッドの後に以下の宣言を追加します。この宣言により、Word アプリケーション オブジェクトへの参照を作成します。

private MSword.Application applicationObject;
以下の行を OnConnection メソッドに追加します。このステートメントにより、Word アプリケーション オブジェクトのインスタンスを作成します。

applicationObject =(MSword.Application)application;
パブリッククラスの Connect ステートメントの末尾にコンマを追加し、IRibbonExtensibility と入力します。

注:

Microsoft IntelliSense を使用して、インターフェイスメソッドを挿入します。たとえば、パブリッククラスの Connect: ステートメントの末尾に IRibbonExtensibility と入力し、右クリックして [インターフェイスの実装] をポイントし、[インターフェイスの明示的な実装] を選択します。これにより、GetCustomUI メソッドのスタブが追加されます。この実装は以下のようなコードになります。
```
   string IRibbonExtensibility.GetCustomUI(string RibbonID) 
 { 
 }
```
次のステートメントを GetCustomUI メソッドに挿入し、既存のコードを上書きします: return GetResource("customUI.xml");
GetCustomUI メソッドの下に次のメソッドを挿入します。
```
 private string GetResource(string resourceName) 
       { 
           Assembly asm = Assembly.GetExecutingAssembly(); 
           foreach (string name in asm.GetManifestResourceNames()) 
           { 
               if (name.EndsWith(resourceName)) 
               { 
                   System.IO.TextReader tr = new System.IO.StreamReader(asm.GetManifestResourceStream(name)); 
                   //Debug.Assert(tr != null); 
                   string resource = tr.ReadToEnd(); 

                   tr.Close(); 
                   return resource; 
               } 
           } 
           return null; 
       } 
```
GetCustomUIメソッドは GetResource メソッドを呼び出します。 GetResource メソッドは、実行時にこのアセンブリへの参照を設定した後、customUI.xml という名前のリソースを見つけるまで埋め込みリソースをループ処理します。次に、XML マークアップが含まれる埋め込みファイルを読み取る StreamReader オブジェクトのインスタンスを作成します。プロシージャは XML を GetCustomUI メソッドに渡し、このメソッドは XML をリボンに戻します。または、XML マークアップが含まれる文字列を構築し、その文字列を GetCustomUI メソッドに直接読み込むこともできます。

GetResource メソッドの後に、このメソッドを追加します。このメソッドは、ドキュメントのページの先頭に会社名を挿入します。

 public void InsertCompanyName(IRibbonControl control) 
       { 
       // Inserts the specified text at the beginning of a range or selection. 
           string MyText; 
           MyText = "Microsoft Corporation"; 

           MSword.Document doc = applicationObject.ActiveDocument; 

           //Inserts text at the beginning of the active document. 
           object startPosition = 0; 
           object endPosition = 0; 
           MSword.Range r = (MSword.Range)doc.Range( 
                 ref startPosition, ref endPosition); 
           r.InsertAfter(MyText); 
       }

プロジェクトをビルドしてインストールする

この手順では、アドインおよびそのセットアッププロジェクトをビルドします。続行する前に、Word が終了していることを確認します。

[プロジェクト] メニューの [ソリューションのビルド] をクリックします。ビルドが完了すると、ウィンドウの左下に通知が表示されます。
ソリューションエクスプローラーで、[RibbonXSampleCSSetup] を右クリックし、[ビルド] をクリックします。
[RibbonXSampleCSSetup] を再度右クリックし、[インストール] をクリックして、RibbonXSampleCSSetup セットアップウィザードを開始します。
各画面で [次へ] をクリックし、最後の画面で [閉じる] をクリックします。
Word を起動します。他のタブの右に [My Tab] タブが表示されます。

プロジェクトをテストする

[My Tab] タブをクリックし、[会社名を挿入する] をクリックして、会社名をドキュメントのカーソルの位置に挿入します。カスタマイズされたリボンが表示されない場合は、次の手順を実行して、Windows レジストリにエントリを追加する必要がある場合があります。

注意

以下の手順では、レジストリの変更方法について説明します。レジストリを変更する前に、レジストリのバックアップを必ず作成し、問題が発生した場合にレジストリを復元する方法について確実に理解しておいてください。レジストリのバックアップ、復元、および編集方法については、Microsoft サポート技術情報で記事「上級ユーザー向けの Windows レジストリ情報 (256986)」を検索してください。

ソリューションエクスプローラーで、セットアッププロジェクトの [RibbonXSampleCSSetup] を右クリックし、[表示] をポイントしてから [レジストリ] をクリックします。
[レジストリ] タブから、アドイン用の次のレジストリキーに移動します。HKCU\Software\Microsoft\Office\Word\AddIns\RibbonXSampleCS.Connect

注:

[RibbonXSampleCS.Connect] キーが存在しない場合は、そのキーを作成できます。キーを作成するには、[アドイン] フォルダーを右クリックし、[新規] をポイントして、[キー] をクリックします。キーに RibbonXSampleCS.Connect という名前を付けます。 LoadBehavior DWord を追加して、その値を 3 に設定します。

Office Fluent リボンのカスタマイズに管理対象 COM アドインを使用する

XML カスタマイズファイルを作成する

マネージ COM アドインプロジェクトを作成する

プロジェクトへの外部参照を追加する

カスタマイズファイルを埋め込みリソースとして追加する

IRibbonExtensibility インターフェイスを実装する

プロジェクトをビルドしてインストールする

プロジェクトをテストする

関連項目

サポートとフィードバック

フィードバック

フィードバック

その他のリソース

Office Fluent リボンのカスタマイズに管理対象 COM アドインを使用する

XML カスタマイズ ファイルを作成する

マネージ COM アドイン プロジェクトを作成する

プロジェクトへの外部参照を追加する

カスタマイズ ファイルを埋め込みリソースとして追加する

IRibbonExtensibility インターフェイスを実装する

プロジェクトをビルドしてインストールする

プロジェクトをテストする

関連項目

サポートとフィードバック

フィードバック

フィードバック

その他のリソース

XML カスタマイズファイルを作成する

マネージ COM アドインプロジェクトを作成する

カスタマイズファイルを埋め込みリソースとして追加する