Windows インストーラーを使用した VSTO ソリューションの配置

[アーティクル]
06/19/2023

まとめ

Visual Studio インストーラープロジェクトを使用して、Microsoft Visual Studio Tools for Office (VSTO) のアドインまたはドキュメントレベルのソリューションを配置する方法について説明します。

Wouter van Vugt、Code Counsel

Ted Pattison、Ted Pattison Group

この記事は、元の作成者の許可を得た上で Microsoft によって更新されたものです。

適用対象: Visual Studio Tools for Office、Microsoft Office、Microsoft Visual Studio。

VSTO ソリューションを開発し、Windows インストーラーパッケージを使用してそのソリューションを配置することができます。ここでは、簡単な Office アドインを配置する手順について説明します。

配置方法

ClickOnce を使用すると、アドインやソリューションのセットアップを簡単に作成できます。ただし、管理特権を必要とするアドイン (マシンレベルのアドインなど) をこれでインストールすることはできません。

管理特権を必要とするアドインは Windows インストーラーを使用してインストールできますが、セットアップの作成にはより多くの作業が必要になります。

ClickOnce を使用して VSTO ソリューションを配置する方法の概要については、「ClickOnce を使用して Office ソリューションを配置する」を参照してください。

VSTO ランタイムを対象とする Office ソリューションの配置

ClickOnce と Windows インストーラーのパッケージでは、Office ソリューションのインストール時に同じ基本的なタスクを実行する必要があります。

ユーザーのコンピューターに前提条件コンポーネントをインストールします。
ソリューション用の特定のコンポーネントを配置します。
アドイン用に、レジストリエントリを作成します。
ソリューションを信頼して実行できるようにします。

ターゲットコンピューターに必要な前提条件コンポーネント

VSTO ソリューションを実行するためにコンピューターにインストールする必要があるソフトウェアの一覧を次に示します。

Microsoft Office 2010 以降。
Microsoft .NET Framework 4 以降。
Microsoft Visual Studio 2010 Tools for Office Runtime このランタイムには、アドインとドキュメントレベルのソリューションを管理する環境が備わっています。 Microsoft Office にはあるバージョンのランタイムが付属していますが、アドインを使用して特定のバージョンを再配布することもできます。
Microsoft Office 用のプライマリ相互運用機能アセンブリ (埋め込まれた相互運用機能型を使用していない場合)。
プロジェクトによって参照される任意のアセンブリ。

ソリューション用の特定のコンポーネント

インストーラーパッケージでは、以下のコンポーネントをユーザーのコンピューターにインストールする必要があります。

Microsoft Office ドキュメント (ドキュメントレベルのソリューションを作成する場合)。
カスタマイズアセンブリとそれに必要なすべてのアセンブリ。
構成ファイルなどの追加のコンポーネント。
アプリケーションマニフェスト (.manifest)。
配置マニフェスト (.vsto)。

アドイン用のレジストリエントリ

Microsoft Office では、レジストリエントリを使用してアドインの検索と読み込みを行います。これらのレジストリエントリは、配置プロセスの一環として作成する必要があります。これらのレジストリエントリの詳細については、「VSTO アドインのレジストリエントリ」を参照してください。

カスタムフォーム領域を表示する Outlook アドインには、それらのフォーム領域を識別できるようにする追加のレジストリエントリが必要です。詳細については、「Outlook フォーム領域のレジストリエントリ」を参照してください。

ドキュメントレベルのソリューションには、レジストリエントリは必要ありません。代わりに、ドキュメント内のプロパティを使用してカスタマイズを検索します。これらのプロパティの詳細については、「カスタムドキュメントプロパティの概要」を参照してください。

VSTO ソリューションへの信頼

カスタマイズが実行されるようにするには、ソリューションがマシンによって信頼される必要があります。アドインを信頼させるには、証明書を使用してマニフェストに署名するか、信頼のリストを使用して信頼関係を築くか、マシン上の信頼できる場所にアドインをインストールします。

署名用の証明書を取得する方法の詳細については、ClickOnce での配置と Authenticode に関するページを参照してください。ソリューションへの信頼の詳細については、信頼のリストを使用した Office ソリューションへの信頼に関するページを参照してください。 Windows インストーラーファイルにカスタムアクションと共に、信頼のリストのエントリを追加できます。信頼のリストを有効にする方法の詳細については、「方法: 信頼のリストのセキュリティを構成する」を参照してください。

どちらのオプションも使用しない場合は、信頼プロンプトがユーザーに表示され、ソリューションを信頼するかどうかを決めることができます。

ドキュメントレベルのソリューションに関連するセキュリティの詳細については、ドキュメントへの信頼の付与に関するページを参照してください。

基本インストーラーの作成

セットアップと配置プロジェクトのテンプレートは、ダウンロード可能な Microsoft Visual Studio Installer Projects 拡張機能に含まれています。

Office ソリューション用のインストーラーを作成するには、次のタスクを実行する必要があります。

配置される Office ソリューションのコンポーネントを追加します。
アプリケーションレベルのアドイン用に、レジストリキーを構成します。
エンドユーザーのコンピューターにインストールできるように、前提条件コンポーネントを構成します。
必須の前提条件コンポーネントが使用可能であることを検証するための起動条件を構成します。起動条件を使用すると、必須の前提条件がすべてインストールされていない場合にインストールをブロックできます。

最初の手順では、セットアッププロジェクトを作成します。

AddIn セットアッププロジェクトを作成するには

配置する Office アドインプロジェクトを開きます。この例では、ExcelAddIn と呼ばれる Excel アドインを使用しています。
Office プロジェクトを開いた状態で、[ファイル] メニューの [追加] を展開し、[新しいプロジェクト] をクリックして新しいプロジェクトを追加します。

[新しいプロジェクトの追加] ダイアログで、[セットアッププロジェクト] テンプレートを選択します。
次へをクリックします。

[名前] ボックスに「OfficeAddInSetup」と入力します。

[作成] をクリックして、新しいセットアッププロジェクトを作成します。

Visual Studio によって、新しいセットアッププロジェクト用のファイルシステムエクスプローラーが開きます。ファイルシステムエクスプローラーでは、セットアッププロジェクトにファイルを追加できます。

Screenshot of the File System Explorer for the setup project

図 1: セットアッププロジェクト用のファイルシステムエクスプローラー

セットアッププロジェクトでは、ExcelAddIn を配置する必要があります。このタスクのセットアッププロジェクトを構成するには、ExcelAddIn プロジェクト出力をセットアッププロジェクトに追加します。

ExcelAddIn プロジェクト出力を追加するには

ソリューションエクスプローラーで、[OfficeAddInSetup] を右クリックし、[追加]、[プロジェクト出力] の順にクリックします。
[プロジェクト出力グループの追加] ダイアログで、プロジェクト一覧から ExcelAddIn を選択して、[プライマリ出力] を選択します。
[OK] をクリックして、プロジェクト出力をセットアッププロジェクトに追加します。

図 2: セットアッププロジェクトの [プロジェクト出力グループの追加] ダイアログ

セットアッププロジェクトでは、配置マニフェストとアプリケーションマニフェストを配置する必要があります。これらの 2 つのファイルは、ExcelAddIn プロジェクトの出力フォルダーからスタンドアロンファイルとしてセットアッププロジェクトに追加します。

配置およびアプリケーションマニフェストを追加するには

ソリューションエクスプローラーで、[OfficeAddInSetup] を右クリックし、[追加]、[ファイル] の順にクリックします。
[ファイルの追加] ダイアログボックスで、ExcelAddIn 出力ディレクトリに移動します。選択したビルド構成にもよりますが、出力ディレクトリは通常、プロジェクトのルートディレクトリ内にある bin\release サブフォルダーです。
ExcelAddIn.vsto および ExcelAddIn.dll.manifest ファイルを選択し、[開く] をクリックして、これらの 2 つのファイルをセットアッププロジェクトに追加します。

図 3: ソリューションエクスプローラーでのアドイン用のアプリケーションおよび配置マニフェスト

ExcelAddIn の参照には、ExcelAddIn に必要なコンポーネントがすべて含まれています。これらのコンポーネントを正しく登録できるようにするには、前提条件パッケージを使用してそれらを除外および配置する必要があります。また、インストールを開始する前に、ソフトウェアライセンス条項を表示し、それに同意する必要もあります。

ExcelAddIn プロジェクトの依存関係を除外するには

ソリューションエクスプローラーの [OfficeAddInSetup] ノードで、[検出された依存関係] 項目の下にあるすべての依存関係項目 (Microsoft .NET Framework と、*.Utilities.dll で終わるすべてアセンブリを除く) を選択します。 Utilities アセンブリは、アプリケーションと共に配置することになっています。
そのグループを右クリックし、[プロパティ] を選択します。
[プロパティ] ウィンドウで、[除外] プロパティを [True] に変更して、それらの依存アセンブリをセットアッププロジェクトから除外します。 Utilities アセンブリを除外しないようにしてください。

図 4: 依存関係の除外

前提条件コンポーネントをインストールするように Windows インストーラーパッケージを構成するには、ブートストラップとも呼ばれるセットアッププログラムを追加します。このセットアッププログラムでは、前提条件コンポーネントのインストール (ブートストラップと呼ばれるプロセス) を実行できます。

ExcelAddIn の場合、アドインを正しく実行するには、以下の必須コンポーネントがインストールされている必要があります。

Office ソリューションで対象となる Microsoft .NET Framework バージョン。
Microsoft Visual Studio 2010 Tools for Office Runtime。

依存コンポーネントを必須コンポーネントとして構成するには

ソリューションエクスプローラーで、OfficeAddInSetup プロジェクトを右クリックして、[プロパティ] を選択します。
[OfficeAddInSetup プロパティページ] ダイアログボックスが表示されます。
[必須コンポーネント] ボタンをクリックします。
[必須コンポーネント] ダイアログボックスで、適切なバージョンの .NET Framework と Microsoft Visual Studio Tools for Office Runtime を選択します。

図 5: [必須コンポーネント] ダイアログボックス

Note

Visual Studio セットアッププロジェクト内の構成済みの前提条件パッケージのいくつかは、選択したビルド構成に依存しています。使用するビルド構成ごとに適切な前提条件コンポーネントを選択する必要があります。

Microsoft Office では、レジストリキーを使用してアドインを検索します。 HKEY_CURRENT_USER ハイブ内のキーは、個々のユーザーごとにアドインを登録するために使用されます。 HKEY_LOCAL_MACHINE ハイブの下にあるキーは、マシンのすべてのユーザーにアドインを登録するために使用されます。これらのレジストリキーの詳細については、「VSTO アドインのレジストリエントリ」を参照してください。

レジストリを構成するには

ソリューションエクスプローラーで、[OfficeAddInSetup] を右クリックします。
[表示] を展開します。
[レジストリ] をクリックして、レジストリエディターのウィンドウを開きます。
レジストリ (OfficeAddInSetup) エディターで、HKEY_LOCAL_MACHINE、Software の順に展開します。
HKEY_LOCAL_MACHINE\Software の [製造元] キーを削除します。
HKEY_CURRENT_USER、Software の順に展開します。
HKEY_CURRENT_USER\Software の下にある [Manufacturer] キーを削除します。
アドインのインストール用のレジストリキーを追加するには、User/Machine Hive キーを右クリックして、[新しいキー] を選択します。新しいキーの名前には、「Software」というテキストを使用します。新しく作成した Software キーを右クリックし、「Microsoft」というテキストを含む新しいキーを作成します。
同様のプロセスを使用して、アドインの登録に必要なキー階層全体を作成します。

User/Machine Hive\Software\Microsoft\Office\Excel\Addins\SampleCompany.ExcelAddIn

会社名は、一意性を持たせるためにアドイン名のプレフィックスとしてよく使用されます。
[SampleCompany.ExcelAddIn] キーを右クリックして [新規] を選択し、[文字列値] をクリックします。 [名前] に「Description」というテキストを使用します。
この手順を使用して、以下の 3 つの値をさらに追加します。
- FriendlyName (String 型)
- LoadBehavior (DWORD 型)
- Manifest (String 型)
レジストリエディターで Description 値を右クリックし、[プロパティウィンドウ] をクリックします。 [プロパティウィンドウ] で、[値] プロパティに「Excel Demo AddIn」と入力します。
レジストリエディターで FriendlyName キーを選択します。 [プロパティウィンドウ] で、[値] プロパティを「Excel Demo AddIn」に変更します。
レジストリエディターで LoadBehavior キーを選択します。 [プロパティウィンドウ] で、[値] プロパティを「3」に変更します。LoadBehavior の値 3 は、ホストアプリケーションの起動時にアドインを読み込むことを示します。読み込み動作の詳細については、「VSTO アドインのレジストリエントリ」を参照してください。
レジストリエディターで Manifest キーを選択します。 [プロパティウィンドウ] で、[値] プロパティを「file:///[TARGETDIR]ExcelAddIn.vsto|vstolocal」に変更します。

図 6: レジストリキーの設定

VSTO ランタイムは、このレジストリキーを使用して配置マニフェストを検索します。 [TARGETDIR] マクロは、アドインがインストールされているフォルダーに置き換えられます。このマクロには末尾に \ 文字が追加されるため、配置マニフェストのファイル名は、\ 文字の付かない ExcelAddIn.vsto にする必要があります。 vstolocal 接尾辞は、ClickOnce キャッシュではなくこの場所からアドインが読み込まれる必要があることを VSTO ランタイムに通知します。この接尾辞を削除すると、ランタイムによってカスタマイズが ClickOnce キャッシュにコピーされます。

警告

Visual Studio でのレジストリエディターの扱いには十分注意してください。たとえば、間違ったキーに DeleteAtUninstall を誤って設定すると、レジストリのアクティブな部分が削除されて、ユーザーのコンピューターが不整合な状態になるか、さらに悪いことに、破損した状態になる可能性があります。

64 ビット版 Office では、64 ビットレジストリハイブを使用してアドインを検索します。64 ビットレジストリハイブの下にアドインを登録する場合は、セットアッププロジェクトのターゲットプラットフォームを 64 ビットのみに設定する必要があります。

ソリューションエクスプローラーで、OfficeAddInSetup プロジェクトを選択します。
[プロパティ] ウィンドウにアクセスし、[TargetPlatform] プロパティを [x64] に設定します。

32 ビット版と 64 ビット版の両方の Office 用にアドインをインストールする場合は、2 つの別々の MSI パッケージを作成する必要があります。 32 ビット版と 64 ビット版にそれぞれ 1 つずつです。

Screenshot of the Properties Window showing the Target Platform for registering Add-ins with 64-bit Office

図 7: 64 ビット版 Office にアドインを登録するためのターゲットプラットフォーム

MSI パッケージを使用してアドインまたはソリューションをインストールする場合、インストール時に必須の前提条件がインストールされないことがあります。 MSI で起動条件を使用すると、必須コンポーネントがインストールされていない場合にアドインのインストールをブロックできます。

VSTO ランタイムを検出するための起動条件を構成する

ソリューションエクスプローラーで、[OfficeAddInSetup] を右クリックします。
[表示] を展開します。
[起動条件] をクリックします。
[起動条件 (OfficeAddInSetup)] エディターで、[ターゲットマシンの要件] を右クリックしてから、[レジストリの起動条件の追加] をクリックします。この検索条件では、VSTO ランタイムでインストールされるキーをレジストリで検索できます。キーの値はその後、名前付きプロパティを通じて、インストーラーのさまざまな部分で使用できます。起動条件では、検索条件で定義されたプロパティを使用して特定の値を確認します。
[起動条件 (OfficeAddInSetup)] エディターで、[Search for RegistryEntry1] 検索条件を選択し、条件を右クリックして、[プロパティウィンドウ] を選択します。
[プロパティ] ウィンドウで、次のプロパティを設定します。
1. (Name) の値を Search for VSTO 2010 Runtime (VSTO 2010 ランタイムの検索) に設定します。
2. Property の値を VSTORUNTIMEREDIST に変更します。
3. RegKey の値を SOFTWARE\Microsoft\VSTO Runtime Setup\v4R に設定します
4. Root プロパティの設定を vsdrrHKLM のままにします。
5. Value プロパティを Version に変更します。
[起動条件 (OfficeAddInSetup)] エディターで、[Condition1] 起動条件を選択し、条件を右クリックして、[プロパティウィンドウ] を選択します。
[プロパティ] ウィンドウで、次のプロパティを設定します。
1. (Name) を Verify VSTO 2010 Runtime availability (VSTO 2010 ランタイムの可用性の検証) に設定します。
2. Condition の値を VSTORUNTIMEREDIST>="10.0.30319" に変更します。
3. InstallUrl プロパティを空白のままにします。
4. Message を The Visual Studio 2010 Tools for Office Runtime is not installed. Please run Setup.exe to install the Add-in (Visual Studio 2010 Tools for Office ランタイムがインストールされていません。Setup.exe を実行してアドインをインストールしてください) に設定します。
  
  図 8: ランタイムの可用性の検証という起動条件の [プロパティ] ウィンドウ

上記の起動条件では、ブートストラップパッケージによって VSTO ランタイムがインストールされるときにその存在を明示的に確認します。

Office によってインストールされた VSTO ランタイムを検出するための起動条件を構成する

[起動条件 (OfficeAddInSetup)] エディターで、[ターゲットマシンの検索] を右クリックしてから、[レジストリ検索の追加] をクリックします。
[Search for RegistryEntry1] 検索条件を選択し、条件を右クリックして、[プロパティウィンドウ] を選択します。
[プロパティ] ウィンドウで、次のプロパティを設定します。
1. (Name) の値を Search for Office VSTO Runtime (Office VSTO ランタイムの検索) に設定します。
2. Property の値を OfficeRuntime に変更します。
3. RegKey の値を SOFTWARE\Microsoft\VSTO Runtime Setup\v4 に設定します
4. Root プロパティの設定を vsdrrHKLM のままにします。
5. Value プロパティを Version に変更します。
[起動条件 (OfficeAddInSetup)] エディターで、前に定義した [Verify VSTO 2010 Runtime availability] 起動条件を選択し、条件を右クリックして、[プロパティウィンドウ] を選択します。
Condition プロパティの値を VSTORUNTIMEREDIST >="10.0.30319" OR OFFICERUNTIME>="10.0.21022" に変更します。バージョン番号は、アドインで必要とされるランタイムのバージョンによって異なる可能性があります。

図 9: 再頒布可能パッケージまたは Office の起動条件を通じてランタイムの可用性を検証するための [プロパティ] ウィンドウ

アドインが .NET Framework 4 以降を対象としている場合は、参照されるプライマリ相互運用機能アセンブリ (PIA) 内の型が VSTO アセンブリに埋め込まれることがあります。

アドインに相互運用機能型が埋め込まれるかどうかを確認するには、次の手順を実行します。

ソリューションエクスプローラーで、[参照] ノードを展開します。
PIA 参照の 1 つ ([Office] など) を選択します。
F4 キーを押すか、アセンブリのコンテキストメニューから [プロパティ] を選択して、[プロパティ] ウィンドウを表示します。
[相互運用機能型の埋め込み] プロパティの値を確認します。

値が True に設定されている場合は、型が埋め込まれるため、「セットアッププロジェクトをビルドするには」セクションに進むことができます。

詳細については、「型の等価性と埋め込まれた相互運用機能型」を参照してください

Office PIA で検出するための起動条件を構成するには

[起動条件 (OfficeAddInSetup)] エディターで、[Requirements on Target Machine]\(ターゲットマシンでの要件)を右クリックしてから、[Windows インストーラーの起動条件の追加] をクリックします。この起動条件では、特定のコンポーネント ID を検索する方法で、Office PIA を検索します。
[Search for Component1] を右クリックし、[プロパティウィンドウ] をクリックして起動条件のプロパティを表示します。
[プロパティ] ウィンドウで、次のプロパティを設定します。
1. (Name) プロパティの値を Search for Office Shared PIA (Office 共有 PIA の検索) に変更します。
2. ComponentID の値を、使用している Office コンポーネントのコンポーネント ID に変更します。コンポーネント ID の一覧は、以下の表で確認できます ({64E2917E-AA13-4CA4-BFFE-EA6EDA3AFCB4} など)。
3. Property プロパティの値を HASSHAREDPIA に変更します。
[起動条件 (OfficeAddInSetup)] エディターで、[Condition1] を右クリックし、[プロパティウィンドウ] をクリックして起動条件のプロパティを表示します。
Condition1 の次のプロパティを変更します。
1. (Name) を Verify Office Shared PIA availability (Office 共有 PIA の可用性の検証) に変更します。
2. Condition を HASSHAREDPIA に変更します。
3. InstallUrl を空白のままにします。
4. Message を A required component for interacting with Excel is not available. Please run setup.exe (Excel との対話に必要なコンポーネントが使用できません。setup.exe を実行してください) に変更します。
図 10: Office 共有 PIA の検証という起動条件の [プロパティ] ウィンドウ

Microsoft Office 用のプライマリ相互運用機能アセンブリのコンポーネント ID

プライマリ相互運用機能アセンブリ	Office 2010	Office 2013	Office 2013 (64 ビット)	Office 2016	Office 2016 (64 ビット)
Excel	{EA7564AC-C67D-4868-BE5C-26E4FC2223FF}	{C8A65ABE-3270-4FD7-B854-50C8082C8F39}	{E3BD1151-B9CA-4D45-A77E-51A6E0ED322A}	{C845E028-E091-442E-8202-21F596C559A0}	{C4ACE6DB-AA99-401F-8BE6-8784BD09F003}
InfoPath	{4153F732-D670-4E44-8AB7-500F2B576BDA}	{0F825A16-25B2-4771-A497-FC8AF3B355D8}	{C5BBD36E-B320-47EF-A512-556B99CB7E41}	-	-
Outlook	{1D844339-3DAE-413E-BC13-62D6A52816B2}	{F9F828D5-9F0B-46F9-9E3E-9C59F3C5E136}	{7824A03F-28CC-4371-BC54-93D15EFC1E7F}	{2C6C511D-4542-4E0C-95D0-05D4406032F2}	{7C6D92EF-7B45-46E5-8670-819663220E4E}
PowerPoint	{EECBA6B8-3A62-44AD-99EB-8666265466F9}	{813139AD-6DAB-4DDD-8C6D-0CA30D073B41}	{05758318-BCFD-4288-AD8D-81185841C235}	{9E73CEA4-29D0-4D16-8FB9-5AB17387C960}	{E0A76492-0FD5-4EC2-8570-AE1BAA61DC88}
Visio	{3EA123B5-6316-452E-9D51-A489E06E2347}	{C1713368-12A8-41F1-ACA1-934B01AD6EEB}	{2CC0B221-22D2-4C15-A9FB-DE818E51AF75}	{A4C55BC1-B94C-4058-B15C-B9D4AE540AD1}	{2D4540EC-2C88-4C28-AE88-2614B5460648}
Word	{8B74A499-37F8-4DEA-B5A0-D72FC501CEFA}	{9FE736B7-B1EE-410C-8D07-082891C3DAC8}	{13C07AF5-B206-4A48-BB5B-B8022333E3CA}	{30CAC893-3CA4-494C-A5E9-A99141352216}	{DC5CCACD-A7AC-4FD3-9F70-9454B5DE5161}
Microsoft Forms 2.0	{B2279272-3FD2-434D-B94E-E4E0F8561AC4}	{B2279272-3FD2-434D-B94E-E4E0F8561AC4}	{A5A30117-2D2A-4C5C-B3C8-8897AC32C2AC}	-	-
Microsoft Graph	{011B9112-EBB1-4A6C-86CB-C2FDC9EA7B0E}	{52DA4B37-B8EB-4B7F-89C1-824654CE4C70}	{24706F33-F0CE-4EB4-BC91-9E935394F510}	-	-
スマートタグ	{7102C98C-EF47-4F04-A227-FE33650BF954}	{487A7921-EB3A-4262-BB5B-A5736B732486}	{74EFC1F9-747D-4867-B951-EFCF29F51AF7}	-	-
Office 共有	{64E2917E-AA13-4CA4-BFFE-EA6EDA3AFCB4}	{6A174BDB-0049-4D1C-86EF-3114CB0C4C4E}	{76601EBB-44A7-49EE-8DE3-7B7B9D7EBB05}	{68477CB0-662A-48FB-AF2E-9573C92869F7}	{625F5772-C1B3-497E-8ABE-7254EDB00506}
Project	{957A4EC0-E67B-4E86-A383-6AF7270B216A}	{1C50E422-24FA-44A9-A120-E88280C8C341}	{706D7F44-8231-489D-9B25-3025ADE9F114}	{0B6EDA1D-4A15-4F88-8B20-EA6528978E4E}	{107BCD9A-F1DC-4004-A444-33706FC10058}

Screenshot of the Final launch conditions

図 11: 最後の起動条件

ExcelAddIn のインストールの起動条件をさらに絞り込むことができます。たとえば、対象となる実際の Office アプリケーションがインストールされているかどうかを確認すると便利な場合があります。

セットアッププロジェクトをビルドするには

ソリューションエクスプローラーで、OfficeAddInSetup プロジェクトを右クリックして、[ビルド] をクリックします。
Windows エクスプローラーを使用して、OfficeAddInSetup プロジェクトの出力ディレクトリに移動し、選択したビルド構成に応じて Release または Debug フォルダーにアクセスします。そのフォルダーのすべてのファイルを、ユーザーがアクセスできる場所にコピーします。

ExcelAddIn のセットアップをテストするには

OfficeAddInSetup をコピーした場所に移動します。
setup.exe ファイルをダブルクリックして、OfficeAddInSetup アドインをインストールします。表示されたソフトウェアライセンス条項に同意し、セットアップウィザードを完了して、ユーザーのコンピューターにアドインをインストールします。

Excel Office ソリューションがインストールされ、セットアップ時に指定した場所から実行されます。

ドキュメントレベルのソリューションの追加要件

ドキュメントレベルのソリューションを配置する場合は、Windows インストーラーのセットアッププロジェクトでいくつかの異なる構成手順を実行する必要があります。

ドキュメントレベルのソリューションを配置するための基本的な手順の一覧を次に示します。

Visual Studio セットアッププロジェクトを作成します。
ドキュメントレベルのソリューションのプライマリ出力を追加します。プライマリ出力には、Microsoft Office ドキュメントも含まれます。
配置およびアプリケーションマニフェストを Loose ファイルとして追加します。
依存コンポーネントをインストーラーパッケージから除外します (すべてのユーティリティアセンブリを除く)。
前提条件パッケージを構成します。
起動条件を構成します。
セットアッププロジェクトをビルドし、結果を配置場所にコピーします。
セットアップを実行して、ドキュメントレベルのソリューションをユーザーのコンピューターに配置します。
必要に応じてカスタムドキュメントのプロパティを更新します。

配置されたドキュメントの場所の変更

Office ドキュメント内のプロパティは、ドキュメントレベルのソリューションを検索するために使用されます。ドキュメントが VSTO アセンブリと同じフォルダーにインストールされている場合、変更は必要ありません。しかし、それが別のフォルダーにインストールされている場合は、セットアップ中にこれらのプロパティを更新する必要があります。

これらのドキュメントプロパティの詳細については、「カスタムドキュメントプロパティの概要」を参照してください。

これらのプロパティを変更するには、セットアップ中にカスタムアクションを使用する必要があります。

次の例では、ExcelWorkbookProject というドキュメントレベルのソリューションと ExcelWorkbookSetup というセットアッププロジェクトを使用します。 ExcelWorkbookSetup プロジェクトは、レジストリキーの設定を除き、上記と同じ手順を使用して構成されます。

カスタムアクションプロジェクトを Visual Studio ソリューションに追加するには

新しい .NET コンソールプロジェクトをソリューションに追加するために、ソリューションエクスプローラーで [Office Document Deployment Project] を右クリックします。
[追加] を展開し、[新しいプロジェクト] をクリックします。
[コンソールアプリ] テンプレートを選択し、プロジェクトに「AddCustomizationCustomAction」という名前を付けます。

図 12: ソリューションエクスプローラー - AddCustomizationCustomAction
以下のアセンブリへの参照を追加します。
1. System.ComponentModel
2. System.Configuration.Install
3. Microsoft.VisualStudio.Tools.Applications
4. Microsoft.VisualStudio.Tools.Applications.ServerDocument
以下のコードを Program.cs または Program.vb にコピーします

    using System;
    using System.IO;
    using System.Collections;
    using System.ComponentModel;
    using System.Configuration.Install;
    using Microsoft.VisualStudio.Tools.Applications;
    using Microsoft.VisualStudio.Tools.Applications.Runtime;

    namespace AddCustomizationCustomAction
    {
        [RunInstaller(true)]
        public class AddCustomizations : Installer
        {
            public AddCustomizations() : base() { }

            public override void Install(IDictionary savedState)
            {
                base.Install(savedState);

                //Get the CustomActionData Parameters
                string documentLocation = Context.Parameters.ContainsKey("documentLocation") ? Context.Parameters["documentLocation"] : String.Empty;
                string assemblyLocation = Context.Parameters.ContainsKey("assemblyLocation") ? Context.Parameters["assemblyLocation"] : String.Empty;
                string deploymentManifestLocation = Context.Parameters.ContainsKey("deploymentManifestLocation") ? Context.Parameters["deploymentManifestLocation"] : String.Empty;
                Guid solutionID = Context.Parameters.ContainsKey("solutionID") ? new Guid(Context.Parameters["solutionID"]) : new Guid();

                string newDocLocation = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments), Path.GetFileName(documentLocation));

                try
                {
                    //Move the file and set the Customizations
                    if (Uri.TryCreate(deploymentManifestLocation, UriKind.Absolute, out Uri docManifestLocationUri))
                    {
                        File.Move(documentLocation, newDocLocation);
                        ServerDocument.RemoveCustomization(newDocLocation);
                        ServerDocument.AddCustomization(newDocLocation, assemblyLocation,
                                                        solutionID, docManifestLocationUri,
                                                        true, out string[] nonpublicCachedDataMembers);
                    }
                    else
                    {
                        LogMessage("The document could not be customized.");
                    }
                }
                catch (ArgumentException)
                {
                    LogMessage("The document could not be customized.");
                }
                catch (DocumentNotCustomizedException)
                {
                    LogMessage("The document could not be customized.");
                }
                catch (InvalidOperationException)
                {
                    LogMessage("The customization could not be removed.");
                }
                catch (IOException)
                {
                    LogMessage("The document does not exist or is read-only.");
                }
            }

            public override void Rollback(IDictionary savedState)
            {
                base.Rollback(savedState);
                DeleteDocument();
            }
            public override void Uninstall(IDictionary savedState)
            {
                base.Uninstall(savedState);
                DeleteDocument();
            }
            private void DeleteDocument()
            {
                string documentLocation = Context.Parameters.ContainsKey("documentLocation") ? Context.Parameters["documentLocation"] : String.Empty;

                try
                {
                    File.Delete(Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments), Path.GetFileName(documentLocation)));
                }
                catch (Exception)
                {
                    LogMessage("The document doesn't exist or is read-only.");
                }
            }
            private void LogMessage(string Message)
            {
                if (Context.Parameters.ContainsKey("LogFile"))
                {
                    Context.LogMessage(Message);
                }
            }

            static void Main() { }
            }
    }

ドキュメントにカスタマイズを追加する場合は、VSTO ドキュメントレベルのソリューションのソリューション ID が必要です。この値は、Visual Studio プロジェクトファイルから取得されます。

ソリューション ID を取得するには

[ビルド] メニューの [ソリューションのビルド] をクリックしてドキュメントレベルのソリューションをビルドし、ソリューション ID プロパティをプロジェクトファイルに追加します。
ソリューションエクスプローラーで、ExcelWorkbookProject というドキュメントレベルのプロジェクトを右クリックします。
[プロジェクトのアンロード] をクリックして、Visual Studio 内からプロジェクトファイルにアクセスします。

図 13: Excel ドキュメントソリューションのアンロード
ソリューションエクスプローラーで、[ExcelWorkbookProject] を右クリックして、[ExcelWorkbookProject.vbproj の編集] または [ExcelWorkbookProject.csproj の編集] をクリックします。
ExcelWorkbookProject のエディターで、PropertyGroup 要素内の SolutionID 要素を見つけます。
この要素の GUID 値をコピーします。

図 14: SolutionID の取得
ソリューションエクスプローラーで、[ExcelWorkbookProject] を右クリックして、[プロジェクトの再読み込み] をクリックします。
表示されるダイアログボックスで [はい] をクリックして、ExcelWorkbookProject のエディターを閉じます。
このソリューション ID は、インストールのカスタムアクションで使用されます。

最後の手順では、[インストール] および [アンインストール] ステップ用のカスタムアクションを構成します。

セットアッププロジェクトを構成するには

ソリューションエクスプローラーで、[ExcelWorkbookSetup] を右クリックし、[追加] を展開して、[プロジェクト出力] をクリックします。
[プロジェクト出力グループの追加] ダイアログボックスの [プロジェクト] ボックスの一覧で、[AddCustomizationCustomAction] をクリックします。
[プライマリ出力] を選択し、[OK] をクリックしてダイアログボックスを閉じ、そのカスタムアクションを含むアセンブリをセットアッププロジェクトに追加します。

図 15: ドキュメントマニフェストのカスタムアクション - [プロジェクト出力グループの追加]
ソリューションエクスプローラーで、[ExcelWorkbookSetup] を右クリックします。
[表示] を展開し、[カスタムアクション] をクリックします。
[カスタムアクション (ExcelWorkbookSetup)] エディターで、[カスタムアクション] を右クリックして、[カスタムアクションの追加] をクリックします。
[プロジェクト内の項目の選択] ダイアログボックスの [検索対象] ボックスの一覧で、[アプリケーションフォルダー] をクリックします。 [Primary output from AddCustomizationCustomAction(Active)] を選択し、[OK] をクリックして、そのカスタムアクションを [インストール] ステップに追加します。
[インストール] ノードで、[Primary output from AddCustomizationCustomAction(Active)] を右クリックして、[名前の変更] をクリックします。カスタムアクションに「Copy document to My Documents and attach customization」(ドキュメントを [マイドキュメント] にコピーし、カスタマイズを添付する) という名前を付けます。
[アンインストール] ノードで、[Primary output from AddCustomizationCustomAction(Active)] を右クリックして、[名前の変更] をクリックします。カスタムアクションに「Remove document from the Documents folder」(ドキュメントを [ドキュメント] フォルダーから削除する) という名前を付けます。

図 16: ドキュメントマニフェストの [カスタムアクション] ウィンドウ
[カスタムアクション (ExcelWorkbookSetup)] エディターで、[Copy document to My Documents and attach customization] を右クリックして、[プロパティウィンドウ] をクリックします。
CustomActionData の [プロパティ] ウィンドウで、カスタマイズ DLL の場所、配置マニフェスト、Microsoft Office ドキュメントの場所を入力します。 SolutionID も必要です。

セットアップエラーをログファイルに記録する場合は、LogFile パラメーターも含めます。 s

/assemblyLocation="[INSTALLDIR]ExcelWorkbookProject.dll" /deploymentManifestLocation="[INSTALLDIR]ExcelWorkbookProject.vsto" /documentLocation="[INSTALLDIR]ExcelWorkbookProject.xlsx" /solutionID="Your Solution ID" /LogFile="[TARGETDIR]Setup.log"

Screenshot of the Custom Action to Copy Document to My Documents Properties window

図 17: ドキュメントを [マイドキュメント] にコピーするカスタムアクション

[アンインストール] 用のカスタムアクションには、ドキュメントの名前が必要です。これは、CustomActionData 内の同じ documentLocation パラメーターを使用して指定できます
```
/documentLocation="[INSTALLDIR]ExcelWorkbookProject.xlsx"
```
ExcelWorkbookSetup プロジェクトをコンパイルして配置します。
[マイドキュメント] フォルダーを検索し、ExcelWorkbookProject.xlsx ファイルを開きます。

その他のリソース

方法: Visual Studio Tools for Office ランタイムをインストールする

Office Primary Interop Assemblies

VSTO アドインのレジストリエントリ

Custom Document Properties Overview

Windows レジストリでのフォーム領域の指定

Granting Trust to Documents

作成者について

Wouter van Vugt 氏は、Office Open XML テクノロジにおける Microsoft MVP であり、SharePoint、Microsoft Office、関連する .NET テクノロジを用いた Office Business Applications (OBA) の作成に重点を置く独立系コンサルタントです。 Wouter は、MSDN などの開発者コミュニティのサイトに頻繁に参加しています。ホワイトペーパーや記事を公表するだけでなく、オンラインで購入できる『Open XML: Explained』という電子書籍も出版しています。 Wouter は、さまざまなチャネルを通じて最先端のテクニカルコンテンツを配信することに注力する、Code-Counsel というオランダ企業の創設者です。 Wouter の詳しいプロフィールについては、ご本人のブログをご覧ください。

Ted Pattison 氏は、SharePoint MVP、作家、トレーナーであり、また Ted Pattison Group の創設者です。 2005 年の秋、Ted は Microsoft の Developer Platform Evangelism グループに採用され、Windows SharePoint Services 3.0 と Microsoft Office SharePoint Server 2007 用の上級開発者向けトレーニングカリキュラムを作成しました。それ以来、Ted は SharePoint 2007 テクノロジのプロフェッショナルな開発者の教育に専念してきました。 Ted は、SharePoint をビジネスソリューションの構築用の開発プラットフォームとして使用する方法に重点を置く『Inside Windows SharePoint Services 3.0』という Microsoft Press の書籍を執筆しました。また、Ted は『Office Space』という MSDN 雑誌に開発者向けコラムも執筆しています。

Windows インストーラーを使用した VSTO ソリューションの配置

まとめ

配置方法