VSTO アドインのレジストリエントリRegistry entries for VSTO Add-ins

Visual Studio で作成した VSTO アドインを配置するときには、一連のレジストリ エントリを作成する必要があります。You must create a specific set of registry entries when you deploy VSTO Add-ins that are created by using Visual Studio. それらのレジストリ エントリで指定する情報によって、Microsoft Office アプリケーションは VSTO アドインを検出し、読み込むことができます。These registry entries provide information that enables the Microsoft Office application to discover and load the VSTO Add-in.

適用対象: このトピックの情報は、VSTO の追加に適用されます-プロジェクト。Applies to: The information in this topic applies to VSTO Add-in projects. 詳細については、「Office アプリケーションおよびプロジェクトの種類で使用できる機能」を参照してください。For more information, see Features available by Office application and project type.

Note

複数のプラットフォームで Office エクスペリエンスを拡張するソリューションの開発に関心がありますか。Interested in developing solutions that extend the Office experience across multiple platforms? 新しいOffice アドインモデルを確認してください。Check out the new Office Add-ins model. Office アドインのフットプリントは、VSTO アドインやソリューションと比較して小さくなります。また、HTML5、JavaScript、CSS3、XML など、ほぼすべての web プログラミングテクノロジを使用してビルドすることができます。Office Add-ins have a small footprint compared to VSTO Add-ins and solutions, and you can build them by using almost any web programming technology, such as HTML5, JavaScript, CSS3, and XML.

プロジェクトをビルドすると、Visual Studio によって開発用コンピューター上にレジストリ エントリが作成されるので、VSTO アドインを簡単に実行およびデバッグできます。When you build your project, Visual Studio creates these registry entries on the development computer so that you can easily run and debug the VSTO Add-in. ClickOnce を使用して VSTO アドインを配置すると、エンドユーザーのコンピューター上にレジストリエントリが自動的に作成されます。If you use ClickOnce to deploy your VSTO Add-in, the registry entries are automatically created on the end-user computer. Windows インストーラーを使用して VSTO アドインを配置する場合は、InstallShield 制限付きエディションプロジェクトを構成して、エンドユーザーのコンピューターにレジストリエントリを作成する必要があります。If you use Windows Installer to deploy your VSTO Add-in, you must configure the InstallShield Limited Edition project to create the registry entries on the end-user computer.

VSTO アドインの読み込みプロセス中にレジストリ エントリがどのように使用されるかについては、「 Architecture of VSTO Add-ins」を参照してください。For more information about how the registry entries are used during the load process for VSTO Add-ins, see Architecture of VSTO Add-ins.

Note

このトピックでは、テキスト アドイン ID は VSTO アドインの一意の ID を表します。In this topic, the text add-in ID represents a unique ID for your VSTO Add-in. 既定では、この ID は VSTO アドイン アセンブリの名前です。By default, the ID is the name of your VSTO Add-in assembly.

現在のユーザーとすべてのユーザーに対して VSTO アドインを登録するRegister VSTO Add-ins for the current user vs. all users

VSTO アドインをインストールするときは、次の 2 つの方法で登録できます。When a VSTO Add-in is installed, it can be registered in two ways:

  • 現在のユーザーのみ (つまり、VSTO アドインをインストールするときにコンピューターにログオンしているユーザーのみが使用できます)。For the current user only (that is, it is available only to the user that is logged on to the computer when the VSTO Add-in is installed). この場合、レジストリエントリはHKEY_CURRENT_USERの下に作成されます。In this case, the registry entries are created under the HKEY_CURRENT_USER.

  • すべてのユーザー (つまり、コンピューターにログオンするすべてのユーザーが VSTO アドインを使用できるようになります)。For all users (that is, any user that logs on to the computer can use the VSTO Add-in). この場合、レジストリエントリはHKEY_LOCAL_MACHINEの下に作成されます。In this case, the registry entries are created under HKEY_LOCAL_MACHINE.

    Visual Studio を使用して作成したすべての VSTO アドインは、現在のユーザー用に登録できます。All VSTO Add-ins that you create by using Visual Studio can be registered for the current user. ただし、特定のシナリオに限り、VSTO アドインをすべてのユーザー用に登録できます。However, VSTO Add-ins can be registered for all users only in certain scenarios. これらのシナリオは、コンピューター上の Microsoft Office のバージョン、および VSTO アドインの配置方法によって異なります。These scenarios depend on the version of Microsoft Office on the computer and how the VSTO Add-in was deployed.

Microsoft Office のバージョンMicrosoft Office version

Office アプリケーションでは、 HKEY_LOCAL_MACHINEまたはHKEY_CURRENT_USERに登録されている VSTO アドインを読み込むことができます。Office applications can load VSTO Add-ins that are registered under HKEY_LOCAL_MACHINE or HKEY_CURRENT_USER.

HKEY_LOCAL_MACHINEに登録されている VSTO アドインを読み込むには、コンピューターに更新プログラムパッケージ976477がインストールされている必要があります。To load VSTO Add-ins that are registered under HKEY_LOCAL_MACHINE, computers must have update package 976477 installed. 詳細については、「http://go.microsoft.com/fwlink/?LinkId=184923」を参照してください。For more information, see http://go.microsoft.com/fwlink/?LinkId=184923.

配置の種類Deployment type

ClickOnce を使用して VSTO アドインを配置する場合は、現在のユーザー用にのみ VSTO アドインを登録できます。If you use ClickOnce to deploy a VSTO Add-in, the VSTO Add-in can be registered only for the current user. これは、ClickOnce がHKEY_CURRENT_USERの下でのキーの作成のみをサポートするためです。This is because ClickOnce only supports creating keys under HKEY_CURRENT_USER. VSTO アドインをコンピューター上のすべてのユーザー用に登録する場合は、Windows インストーラーを使用して VSTO アドインを配置する必要があります。If you want to register a VSTO Add-in to all users on a computer, you must use Windows Installer to deploy the VSTO Add-in. これらの展開の種類の詳細については、「 ClickOnce を使用した office ソリューションの配置」と「 Windows インストーラーを使用した Office ソリューションの配置」を参照してください。For more information about these deployment types, see Deploy an Office solution by using ClickOnce and Deploy an Office solution by using Windows Installer.

レジストリ エントリRegistry entries

必要な VSTO アドインレジストリエントリは、Visio を除くすべてのアプリケーションの次のレジストリキーの下にあります。 RootHKEY_CURRENT_USERまたはHKEY_LOCAL_MACHINEです。The required VSTO Add-in registry entries are located under the following registry key for all applications except Visio, where Root is HKEY_CURRENT_USER or HKEY_LOCAL_MACHINE.

Visio を除くすべてのアプリケーションAll applications except for Visio

Office のバージョンOffice version 構成パスConfiguration Path
32 ビット32-bit ルート\Software\Microsoft\Office\アプリケーション名\ アドイン\アドイン IDRoot\Software\Microsoft\Office\application name\Addins\add-in ID
64 ビット64-bit ルート\Software\Wow6432Node\Microsoft\Office\アプリケーション名\ アドイン\アドイン IDRoot\Software\Wow6432Node\Microsoft\Office\application name\Addins\add-in ID

VisioVisio

Office のバージョンOffice version 構成パスConfiguration Path
32 ビット32-bit ルート\Software\Microsoft\Visio\Addins\アドイン IDRoot\Software\Microsoft\Visio\Addins\add-in ID
64 ビット64-bit ルート\Software\Wow6432Node\Visio\Addins\アドイン IDRoot\Software\Wow6432Node\Visio\Addins\add-in ID

このレジストリ キーの下にあるエントリを次の表に示します。The following table lists the entries under this registry key.

入力Entry [種類]Type [値]Value
説明Description REG_SZREG_SZ 必須です。Required. VSTO アドインの簡単な説明。A brief description of the VSTO Add-in.

この説明は、ユーザーが Microsoft Office アプリケーションの [オプション] ダイアログ ボックスの [アドイン] ペインで VSTO アドインを選択したときに表示されます。This description is displayed when the user selects the VSTO Add-in in the Add-Ins pane of the Options dialog box in the Microsoft Office application.
FriendlyNameFriendlyName REG_SZREG_SZ 必須です。Required. Microsoft Office アプリケーションの [COM アドイン] ダイアログ ボックスに表示される、VSTO アドインの説明的な名前。A descriptive name of the VSTO Add-in that is displayed in the COM Add-Ins dialog box in the Microsoft Office application. 既定値は VSTO アドイン ID です。The default value is the VSTO Add-in ID.
LoadBehaviorLoadBehavior REG_DWORDREG_DWORD 必須です。Required. アプリケーションが VSTO アドインを読み込みを試行した時点と、VSTO アドインの現在の状態 (読み込まれているかアンロードされているか) を示す値。A value that specifies when the application attempts to load the VSTO Add-in and the current state of the VSTO Add-in (loaded or unloaded).

このエントリの既定値は 3 です。これは、VSTO アドインが起動時に読み込まれたことを示します。By default, this entry is set to 3, which specifies that the VSTO Add-in is loaded at startup. 詳細については、「 LoadBehavior values」を参照してください。For more information, see LoadBehavior values. 注: ユーザーが VSTO アドインを無効にすると、その操作によってHKEY_CURRENT_USERレジストリハイブのLoadBehavior値が変更されます。Note: If a user disables the VSTO Add-in, that action modifies LoadBehavior value in the HKEY_CURRENT_USER registry hive. 各ユーザーについて、HKEY_CURRENT_USER ハイブのLoadBehavior値の値は、 HKEY_LOCAL_MACHINE hive で定義されている既定のLoadBehaviorよりも優先されます。For each user, the value of the LoadBehavior value in the HKEY_CURRENT_USER hive overrides the default LoadBehavior defined in the HKEY_LOCAL_MACHINE hive.
マニフェストManifest REG_SZREG_SZ 必須です。Required. VSTO アドインの配置マニフェストの完全なパス。The full path of the deployment manifest for the VSTO Add-in. ローカル コンピューター上の場所、ネットワーク共有 (UNC)、Web サーバー (HTTP) のいずれかを指定できます。The path can be a location on the local computer, a network share (UNC), or a Web server (HTTP).

Windows インストーラーを使用してソリューションを配置する場合、 マニフェスト パスにプレフィックス " file:/// " を追加する必要があります。If you use Windows Installer to deploy the solution, you must add the prefix file:/// to the manifest path. また、文字列 |vstolocal (つまり、パイプ文字 | の後にvstolocalを続けたもの) をこのパスの末尾に追加する必要があります。You must also append the string |vstolocal (that is, the pipe character | followed by vstolocal) to the end of this path. これにより、ClickOnce キャッシュではなく、インストール フォルダーからソリューションが読み込まれます。This ensures that your solution is loaded from the installation folder, rather than the ClickOnce cache. 詳細については、「 Windows インストーラーを使用した Office ソリューションの配置」を参照してください。For more information, see Deploy an Office solution by using Windows Installer. 注: 開発用コンピューターで VSTO アドインをビルドすると、Visual Studio によって |vstolocal文字列がこのレジストリエントリに自動的に追加されます。Note: When you build a VSTO Add-in on the development computer, Visual Studio automatically appends the |vstolocal string to this registry entry.

Outlook フォーム領域のレジストリエントリRegistry entries for Outlook form regions

Outlook 用 VSTO アドインにカスタム フォーム領域を作成する場合は、フォーム領域を Outlook に登録するために追加のレジストリ エントリが使用されます。If you create a custom form region in a VSTO Add-in for Outlook, additional registry entries are used to register the form region with Outlook. これらのエントリは、フォーム領域がサポートするメッセージ クラスごとに異なるレジストリ キーの下に作成されます。These entries are created under a different registry key for each message class that the form region supports. これらのレジストリキーは次の場所にあります。 RootHKEY_CURRENT_USERまたはHKEY_LOCAL_MACHINEです。These registry keys are in the following location, where Root is HKEY_CURRENT_USER or HKEY_LOCAL_MACHINE.

Root\Software\Microsoft\Office\Outlook\FormRegions\message クラスRoot\Software\Microsoft\Office\Outlook\FormRegions\message class

すべての VSTO アドインで共有されるその他のレジストリ エントリと同様に、プロジェクトをビルドすると、Visual Studio によって開発用コンピューター上にフォーム領域レジストリ エントリが作成されます。Like the other registry entries shared by all VSTO Add-ins, Visual Studio creates the form region registry entries on the development computer when you build your project. ClickOnce を使用して VSTO アドインを配置すると、エンドユーザーのコンピューター上にレジストリエントリが自動的に作成されます。If you use ClickOnce to deploy your VSTO Add-in, the registry entries are automatically created on the end-user computer. Windows インストーラーを使用して VSTO アドインを配置する場合は、InstallShield 制限付きエディションプロジェクトを構成して、エンドユーザーのコンピューターにレジストリエントリを作成する必要があります。If you use Windows Installer to deploy your VSTO Add-in, you must configure the InstallShield Limited Edition project to create the registry entries on the end-user computer.

フォーム領域レジストリエントリの詳細については、「カスタムフォームでのフォーム領域の位置の指定」を参照してください。For more information about the form region registry entries, see Specify the location of a form region in a custom form. Outlook フォーム領域の詳細については、「 outlook フォーム領域の作成」を参照してください。For more information about Outlook form regions, see Create Outlook form regions.

LoadBehavior の値LoadBehavior values

ルート\Software\Microsoft\Office\アプリケーション名の下のLoadBehaviorエントリ\アドイン IDキーには、VSTO アドインの実行時の動作を指定する値のビットごとの組み合わせが含まれています。The LoadBehavior entry under the Root\Software\Microsoft\Office\application name\Addins\add-in ID key contains a bitwise combination of values that specify the run time behavior of the VSTO Add-in. 最下位のビット (値 0 および 1) は、VSTO アドインが現在アンロードされているか、または読み込み済みであるかを示します。The lowest order bit (values 0 and 1) indicates whether the VSTO Add-in is currently unloaded or loaded. その他のビットは、アプリケーションが VSTO アドインを読み込もうとしていることを示します。Other bits indicate when the application attempts to load the VSTO Add-in.

通常、 LoadBehaviorエントリは、VSTO アドインをエンドユーザーのコンピューターにインストールするときに、0、3、または 16 (10 進数) に設定することを目的としています。Typically, the LoadBehavior entry is intended to be set to 0, 3, or 16 (in decimal) when the VSTO Add-in is installed on end-user computers. 既定では、VSTO アドインをビルドまたは発行すると、Visual Studio によってアドインの LoadBehavior エントリが 3 に設定されます。By default, Visual Studio sets the LoadBehavior entry of your VSTO Add-in to 3 when you build or publish it.

LoadBehavior エントリに指定できるすべての値を次の表に示します。The following table lists all the possible values of the LoadBehavior entry. この表では、VSTO アドインを手動またはプログラムによって読み込む場合も示されています。Some descriptions in this table refer to loading a VSTO Add-in manually or programmatically. VSTO アドインを手動で読み込むには、アプリケーションの [COM アドイン] ダイアログ ボックスで、VSTO アドインの横にあるチェック ボックスをオンにします。To load a VSTO Add-in manually, select the check box next to the VSTO Add-in in the COM Add-Ins dialog box in the application. VSTO アドインをプログラムによって読み込むには、VSTO アドインを表す Connect オブジェクトの Microsoft.Office.Core.COMAddIn プロパティを true」を参照してください。To load a VSTO Add-in programmatically, set the Connect property of the Microsoft.Office.Core.COMAddIn object that represents the VSTO Add-in to true.

値 (10 進形式)Value (in decimal) VSTO アドインの状態VSTO Add-in status VSTO アドインの読み込み動作VSTO Add-in load behavior 説明Description
00 アンロードされましたUnloaded 自動的に読み込まないDo not load automatically VSTO アプリケーションは自動的にアドインを読み込みません。The application never tries to load the VSTO Add-in automatically. VSTO アドインを読み込むには、ユーザーが手動で読み込むか、またはプログラムによって読み込みます。The user can try to manually load the VSTO Add-in, or the VSTO Add-in can be loaded programmatically.

VSTO アドインの読み込みが成功した場合、 LoadBehavior の値は 0 のままですが、 [COM アドイン] ダイアログ ボックスの VSTO アドインの状態は更新されて、VSTO アドインが読み込み済みであることが示されます。If the VSTO Add-in is successfully loaded, the LoadBehavior value remains 0, but the status of the VSTO Add-in in the COM Add-ins dialog box is updated to indicate that the VSTO Add-in is loaded.
11 読み込みLoaded 自動的に読み込まないDo not load automatically VSTO アプリケーションは自動的にアドインを読み込みません。The application never tries to load the VSTO Add-in automatically. VSTO アドインを読み込むには、ユーザーが手動で読み込むか、またはプログラムによって読み込みます。The user can try to manually load the VSTO Add-in, or the VSTO Add-in can be loaded programmatically.

[COM アドイン] ダイアログボックスには、アプリケーションの起動時に vsto アドインが読み込まれることが示されますが、手動またはプログラムによって読み込まれるまで vsto アドインは読み込まれません。Although the COM Add-ins dialog box indicates that the VSTO Add-in is loaded after the application starts, the VSTO Add-in isn't loaded until it is loaded manually or programmatically.

VSTO アドインの読み込みが成功した場合、 LoadBehavior の値は 0 に変更されます。アプリケーションの終了後も 0 のままです。If the application successfully loads the VSTO Add-in, the LoadBehavior value changes to 0, and remains at 0 after the application closes.
22 アンロードされましたUnloaded スタート時に読み込むLoad at startup アプリケーションは自動的に VSTO アドインを読み込みません。The application does not try to load the VSTO Add-in automatically. VSTO アドインを読み込むには、ユーザーが手動で読み込むか、またはプログラムによって読み込みます。The user can try to manually load the VSTO Add-in, or the VSTO Add-in can be loaded programmatically.

VSTO アドインの読み込みが成功した場合、 LoadBehavior の値は 3 に変更されます。アプリケーションの終了後も 3 のままです。If the application successfully loads the VSTO Add-in, the LoadBehavior value changes to 3, and remains at 3 after the application closes.
33 読み込みLoaded スタート時に読み込むLoad at startup アプリケーションが起動時に VSTO アドインを読み込もうとします。The application tries to load the VSTO Add-in when the application starts. これは、Visual Studio で VSTO アドインをビルドまたは発行した場合の既定値です。This is the default value when you build or publish a VSTO Add-in in Visual Studio.

VSTO アドインの読み込みが成功した場合、 LoadBehavior の値は 3 のままです。If the application successfully loads the VSTO Add-in, the LoadBehavior value remains 3. VSTO アドインの読み込み中にエラーが発生した場合、 LoadBehavior の値は 2 に変更されます。アプリケーションの終了後も 2 のままです。If an error occurs when loading the VSTO Add-in, the LoadBehavior value changes to 2, and remains at 2 after the application closes.
88 アンロードされましたUnloaded 必要に応じて読み込むLoad on demand アプリケーションは自動的に VSTO アドインを読み込みません。The application does not try to load the VSTO Add-in automatically. VSTO アドインを読み込むには、ユーザーが手動で読み込むか、またはプログラムによって読み込みます。The user can try to manually load the VSTO Add-in, or the VSTO Add-in can be loaded programmatically.

VSTO アドインの読み込みが成功した場合、 LoadBehavior の値は 9 に変更されます。If the application successfully loads the VSTO Add-in, the LoadBehavior value changes to 9.
99 読み込みLoaded 必要に応じて読み込むLoad on demand VSTO アドインの機能を使用する UI 要素 (たとえば、リボンのカスタム ボタン) をユーザーがクリックしたときなど、アプリケーションで要求されたときにのみ VSTO アドインが読み込まれます。The VSTO Add-in will be loaded only when the application requires it, such as when a user clicks a UI element that uses functionality in the VSTO Add-in (for example, a custom button in the Ribbon).

VSTO アドインの読み込みが成功した場合、 LoadBehavior の値は 9 のままですが、 [COM アドイン] ダイアログ ボックスの VSTO アドインの状態は更新されて、VSTO アドインが現在読み込み済みであることが示されます。If the application successfully loads the VSTO Add-in, the LoadBehavior value remains 9, but the status of the VSTO Add-in in the COM Add-ins dialog box is updated to indicate that the VSTO Add-in is currently loaded. VSTO アドインの読み込み中にエラーが発生した場合は、 LoadBehavior の値が 8 に変更されます。If an error occurs when loading the VSTO Add-in, the LoadBehavior value changes to 8.
1616 読み込みLoaded 初回に読み込み、その後必要に応じて読み込むLoad first time, then load on demand VSTO アドインを必要に応じて読み込む場合は、この値を設定します。Set this value if you want your VSTO Add-in to be loaded on demand. ユーザーが最初にアプリケーションを起動したときに、アプリケーションが VSTO アドインを読み込みます。The application loads the VSTO Add-in when the user runs the application for the first time. ユーザーが次にアプリケーションを実行したときには、VSTO アドインによって定義された UI 要素が読み込まれますが、VSTO アドインはユーザーが VSTO アドインに関連付けられた UI 要素をクリックするまで読み込まれません。The next time the user runs the application, the application loads any UI elements that are defined by the VSTO Add-in, but the VSTO Add-in is not loaded until the user clicks a UI element that is associated with the VSTO Add-in.

VSTO アドインの最初の読み込みが成功した場合、VSTO アドインが読み込まれている間 LoadBehavior の値は 16 のままです。When the application successfully loads the VSTO Add-in for the first time, the LoadBehavior value remains 16 while the VSTO Add-in is loaded. アプリケーションの終了後、 LoadBehavior の値は 9 に変更されます。After the application closes, the LoadBehavior value changes to 9.

関連項目See also