アプリケーション レベルのアドインのレジストリ エントリ
Visual Studio 2012 で作成したアドインを配置するときには、一連のレジストリ エントリを作成する必要があります。それらのレジストリ エントリで指定する情報によって、Microsoft Office アプリケーションはアドインを検出し、読み込むことができます。
対象: このトピックの情報は、Microsoft Office 2013 および Microsoft Office 2010 のアプリケーション レベルのプロジェクトに適用されます。詳細については、「Office アプリケーションおよびプロジェクト タイプ別の使用可能な機能」を参照してください。
プロジェクトをビルドすると、Visual Studio によって開発用コンピューター上にレジストリ エントリが作成されるので、アドインを簡単に実行およびデバッグできます。ClickOnce を使用してアドインを配置する場合は、エンド ユーザーのコンピューター上にレジストリ エントリが自動的に作成されます。アドインを配置に Windows インストーラーを使用してエンド ユーザーのコンピューター上にレジストリ エントリを作成する InstallShield Limited Edition プロジェクトを構成する必要があります。
アドインの読み込みプロセス中にレジストリ エントリがどのように使用されるかについては、「アプリケーション レベルのアドインのアーキテクチャ」を参照してください。
[!メモ]
このトピックでは、add-in ID はアドインの一意の ID を表します。既定では、この ID はアドイン アセンブリの名前です。
現在のユーザー用のアドインに対する. すべてのユーザー登録
インストールされたアドインは、2 つの方法で登録できます。
現在のユーザーのみ (アドインのインストール時にコンピューターにログオンしていたユーザーのみが使用可能)。この場合、レジストリ エントリは HKEY_CURRENT_USER の下に作成されます。
すべてのユーザー (コンピューターにログオンしたすべてのユーザーがアドインを使用可能)。この場合、レジストリ エントリは HKEY_LOCAL_MACHINE の下に作成されます。
Visual Studio 2012 を使用して作成したすべてのアドインは、現在のユーザー用に登録できます。ただし、特定のシナリオに限り、アドインをすべてのユーザー用に登録できます。これらのシナリオは、コンピューター上の Microsoft Office のバージョン、およびアドインの配置方法によって異なります。
.gif "Bb386106.collapse_all(ja-jp,VS.110).gif")
Microsoft Office のバージョン
HKEY_LOCAL_MACHINE または HKEY_CURRENT_USER に登録されている Microsoft Office 2010 および Microsoft Office 2013 アプリケーションがアドインを読み込むことができます。
アドインを読み込むには、HKEY_LOCAL_MACHINE に登録された、コンピューターにがインストールされている更新プログラム パッケージ 976477 が必要です。詳細については、https://go.microsoft.com/fwlink/?LinkId=184923 を参照してください。
配置タイプ
ClickOnce を使用してアドインを配置する場合は、現在のユーザー用にのみアドインを登録できます。これは、ClickOnce が HKEY_CURRENT_USER の下へのキーの作成のみをサポートしているためです。アドインをコンピューター上のすべてのユーザー用に登録する場合は、Windows インストーラーを使用してアドインを配置する必要があります。これらの配置タイプの詳細については、「ClickOnce を使用した Office ソリューションの配置」および「Windows インストーラーを使用した Office ソリューションの配置」を参照してください。
レジストリ エントリ
必要なアドイン レジストリ エントリは、Visio を除くすべてのアプリケーションで次のレジストリ キーの下にあります。"Root" は HKEY_CURRENT_USER または HKEY_LOCAL_MACHINE です。
Root\Software\Microsoft\Office\<アプリケーション名>\Addins\<アドイン ID>
Visio の場合、レジストリ エントリは次のレジストリ キーの下にあります。
Root\Software\Microsoft\Visio\Addins\<アドイン ID>
このレジストリ キーの下にあるエントリを次の表に示します。
エントリ |
型 |
価値 |
|---|---|---|
Description |
REG_SZ |
必須です。アドインの簡単な説明。 この説明は、ユーザーが Microsoft Office アプリケーションの [オプション] ダイアログ ボックスの [アドイン] ペインでアドインを選択したときに表示されます。 |
FriendlyName |
REG_SZ |
必須です。Microsoft Office アプリケーションの [COM アドイン] ダイアログ ボックスに表示される、アドインの説明的な名前。既定値はアドイン ID です。 |
LoadBehavior |
REG_DWORD |
必須です。アプリケーションがアドインを読み込んだ時点とアドインの現在の状態 (読み込まれているかアンロードされたか) を示す値。 このエントリの既定値は 3 です。これは、アドインが起動時に読み込まれたことを示します。詳細については、「LoadBehavior の値」を参照してください。 |
Manifest |
REG_SZ |
必須です。アドインの配置マニフェストの完全パス。ローカル コンピューター上の場所、ネットワーク共有 (UNC)、Web サーバー (HTTP) のいずれかを指定できます。 ソリューションを配置に Windows インストーラーを使用して マニフェスト のパスにプレフィックス file:/// を追加する必要があります。文字列 |vstolocal (パイプ文字を追加する必要があります。| の後ろに "vstolocal") をこのパスの最後に追加します。これにより、ClickOnce キャッシュではなく、インストール フォルダーからソリューションが読み込まれます。詳細については、「Windows インストーラーを使用した Office ソリューションの配置」を参照してください。 .gif "メモ") メモ
開発用コンピューターでアドインをビルドすると、Visual Studio によって文字列 "|vstolocal" が自動的にレジストリ エントリに追加されます。
|
Warmup |
REG_DWORD |
省略可能です。アドインを読み込む前に .NET Framework と Visual Studio Tools for Office Runtime を読み込んで、認識されるアドイン読み込み時間を短縮することを示す値です。Warmup のエントリを 1 に設定し、LoadBehavior のエントリとともに、Windows インストーラー (.msi) を使用して配置される Outlook 2013 アドインおよび Outlook 2010 の読み込み時間を減らすために使用します。このレジストリ キーは、ClickOnce を使用して設定することはできません。 |
Outlook フォーム領域のレジストリ エントリ
Outlook 用アドインにカスタム フォーム領域を作成する場合は、フォーム領域を Outlook に登録するために追加のレジストリ エントリが使用されます。これらのエントリは、フォーム領域がサポートするメッセージ クラスごとに異なるレジストリ キーの下に作成されます。これらのレジストリ キーは次の場所にあります。"Root" は HKEY_CURRENT_USER または HKEY_LOCAL_MACHINE です。
Root\Software\Microsoft\Office\Outlook\FormRegions\<メッセージ クラス>
すべてのアドインで共有されるその他のレジストリ エントリと同様に、プロジェクトをビルドすると、Visual Studio によって開発用コンピューター上にフォーム領域レジストリ エントリが作成されます。ClickOnce を使用してアドインを配置する場合は、エンド ユーザーのコンピューター上にレジストリ エントリが自動的に作成されます。アドインを配置に Windows インストーラーを使用してエンド ユーザーのコンピューター上にレジストリ エントリを作成する InstallShield Limited Edition プロジェクトを構成する必要があります。
フォーム領域レジストリ エントリの詳細については、「Specifying Form Regions in the Windows Registry (Windows レジストリ内のフォーム領域の指定)」を参照してください。Outlook フォーム領域の詳細については、「Outlook フォーム領域の作成」を参照してください。
LoadBehavior の値
Root\Software\Microsoft\Office\<アプリケーション名>\Addins\<アドイン ID> キーの下にある LoadBehavior エントリには、アドインの実行時の動作を指定する値のビットごとの組み合わせが含まれています。最下位のビット (値 0 および 1) は、アドインが現在アンロードされているか、または読み込み済みであるかを示します。その他のビットは、アプリケーションがアドインを読み込もうとしていることを示します。
通常、アドインがエンド ユーザーのコンピューターにインストールされている場合は、LoadBehavior エントリは 10 進数の 0、3、または 16 に設定されます。既定では、アドインをビルドまたは発行すると、Visual Studio によってアドインの LoadBehavior エントリが 3 に設定されます。
LoadBehavior エントリに指定できるすべての値を次の表に示します。この表では、アドインを手動またはプログラムによって読み込む場合も示されています。アドインを手動で読み込むには、アプリケーションの [COM アドイン] ダイアログ ボックスで、アドインの横にあるチェック ボックスをオンにします。アドインをプログラムによって読み込むには、アドインを表す COMAddIn オブジェクトの Connect プロパティを true に設定します。
値 (10 進形式) |
アドインの状態 |
アドインの読み込み動作 |
説明 |
|---|---|---|---|
0 |
アンロード |
自動的に読み込まない |
アプリケーションは自動的にアドインを読み込みません。アドインを読み込むには、ユーザーが手動で読み込むか、またはプログラムによって読み込みます。 アドインの読み込みが成功した場合、LoadBehavior の値は 0 のままですが、[COM アドイン] ダイアログ ボックスのアドインの状態は更新されて、アドインが読み込み済みであることが示されます。 |
1 |
読み込み済み |
自動的に読み込まない |
アプリケーションは自動的にアドインを読み込みません。アドインを読み込むには、ユーザーが手動で読み込むか、またはプログラムによって読み込みます。 アプリケーションの起動後、[COM アドイン] ダイアログ ボックスにはアドインが読み込み済みであることが示されますが、手動またはプログラムによって読み込まれるまでアドインは実際には読み込まれません。 アドインの読み込みが成功した場合、LoadBehavior の値は 0 に変更されます。アプリケーションの終了後も 0 のままです。 |
2 |
アンロード |
スタート時に読み込む |
アプリケーションは自動的にアドインを読み込みません。アドインを読み込むには、ユーザーが手動で読み込むか、またはプログラムによって読み込みます。 アドインの読み込みが成功した場合、LoadBehavior の値は 3 に変更されます。アプリケーションの終了後も 3 のままです。 |
3 |
読み込み済み |
スタート時に読み込む |
アプリケーションが起動時にアドインを読み込もうとします。これは、Visual Studio でアドインをビルドまたは発行した場合の既定値です。 アドインの読み込みが成功した場合、LoadBehavior の値は 3 のままです。アドインの読み込み中にエラーが発生した場合、LoadBehavior の値は 2 に変更されます。アプリケーションの終了後も 2 のままです。 |
8 |
アンロード |
必要に応じて読み込む |
アプリケーションは自動的にアドインを読み込みません。アドインを読み込むには、ユーザーが手動で読み込むか、またはプログラムによって読み込みます。 アドインの読み込みが成功した場合、LoadBehavior の値は 9 に変更されます。 |
9 |
読み込み済み |
必要に応じて読み込む |
アドインの機能を使用する UI 要素 (たとえば、リボンのカスタム ボタン) をユーザーがクリックしたときなど、アプリケーションで要求されたときにのみアドインが読み込まれます。 アドインの読み込みが成功した場合、LoadBehavior の値は 9 のままですが、[COM アドイン] ダイアログ ボックスのアドインの状態は更新されて、アドインが現在読み込み済みであることが示されます。アドインの読み込み中にエラーが発生した場合は、LoadBehavior の値が 8 に変更されます。 |
16 |
読み込み済み |
初回に読み込み、その後必要に応じて読み込む |
アドインを必要に応じて読み込む場合は、この値を設定します。ユーザーが最初にアプリケーションを起動したときに、アプリケーションがアドインを読み込みます。ユーザーが次にアプリケーションを実行したときには、アドインによって定義された UI 要素が読み込まれますが、アドインはユーザーがアドインに関連付けられた UI 要素をクリックするまで読み込まれません。 アドインの最初の読み込みが成功した場合、アドインが読み込まれている間 LoadBehavior の値は 16 のままです。アプリケーションの終了後、LoadBehavior の値は 9 に変更されます。 |