How To: セットアップ後にインストールしたアプリケーションを実行する

大抵アプリケーションのインストールを完了している時には、セットアップが完了した時にインストールされたアプリケーションをただちに開始するオプションを提供する事が望ましい。この how to は、デフォルト WiX UI エクスペリエンスを、チェックボックスともしチェックボックスがチェックされていたらアプリケーションを開始する WiX カスタムアクションをインクルードして、カスタマイズする事を述べています。

この how to は、How To: インストーラーにファイルを追加するで概要が示されたステップを使ってベーシックな WiX プロジェクトを既に作成したものと仮定しています。

Step 1: プロジェクトに extension ライブラリーを追加する

このウォークスルーは、UI コンポーネントとカスタムアクションの為の WiX extension を必要とします。これらの extension ライブラリーは、使用する前にプロジェクトに追加されなければなりません。もしコマンドラインで WiX を使っているなら、以下を candle と light のコマンドラインに追加する必要があります：

-ext WixUIExtension -ext WixUtilExtension

もし Visual Studio を使っているなら、Add Reference dialog を使って extension を追加する事ができます：

ソリューションエクスプローラーでプロジェクトを右クリックして、Add Reference... を選ぶ
リストから WixUIExtension.dll アセンブリを選んで、追加をクリックする
リストから WixUtilExtension.dll アセンブリを選んで、追加をクリックする
Add Reference dialog を閉じる

Step 2: インストーラーに UI を追加する

WiX Minimal UI シーケンスは、オプションのチェックボックスを持つ完了ダイアログを含むベーシックなダイアログセットを含んでいます。プロジェクトにシーケンスをインクルードするには、<Product> エレメント内のどこかに以下のスニペットを追加して下さい。

<UI>
    <UIRef Id="WixUI_Minimal" />
</UI>

インストーラーの最後の画面でチェックボックスを表示するには、<Product> エレメント内のどこかで以下のスニペットをインクルードして下さい。

<Property Id="WIXUI_EXITDIALOGOPTIONALCHECKBOXTEXT" Value="Launch My Application Name" />

WIXUI_EXITDIALOGOPTIONALCHECKBOXTEXT プロパティは、スタンダードな UI シーケンスによって提供されており、それは、セットされると、チェックボックスを表示してチェックボックスラベルとして指定された値を使用します。

Step 3: カスタムアクションをインクルードする

カスタムアクションは、WiX プロジェクトで <CustomAction> エレメントを使ってインクルードされています。アプリケーションを実行する事は、WixShellExec カスタムアクションで達成されています。 Windows Installer にカスタムアクションについて知らせ、そのプロパティをセットするには、プロジェクトで <Product> エレメント内のどこかで以下をインクルードして下さい：

<Property Id="WixShellExecTarget" Value="[#myapplication.exe]" />
<CustomAction Id="LaunchApplication" BinaryKey="WixCA" DllEntry="WixShellExec" Impersonate="yes" />

Property エレメントは、WixShellExecTarget をインストールされたアプリケーションの位置にセットします。WixShellExecTarget はプロパティ id で、WixShellExec カスタムアクションは実行するファイルの位置にセットされているだろうと期待しています。Value プロパティは、 myapplication.exe でインストールされたファイルのフルパスを調べる事を WiX に知らせる為に特殊な文字 # を使用しています。

CustomAction エレメントは、インストーラーにアクションをインクルードします。ユニーク id 、 BinaryKey 、カスタムアクションの為のアセンブリとエントリーポイントを示す DllEntry が与えられています。Impersonate プロパティは、Windows Installer にインストールしているユーザーとしてカスタムアクションを実行する事を知らせています。

Step 4: カスタムアクションのトリガーを引く

Step 3 でのように、単にカスタムアクションをインクルードする事は、実行させるには足りていません。Windows Installer は、カスタムアクションのトリガーが引かれるべき時に知らされる事も必要です。これは、ユーザーが UI ダイアログの最後のページで完了ボタンをクリックした時のアクションの実行に、それを追加する為に <Publish> エレメントを使う事によってなされています。Publish エレメントは、Step 2 からの <UI> エレメント内でインクルードされるべきで、このようになります：

<Publish Dialog="ExitDialog"
    Control="Finish" 
    Event="DoAction" 
    Value="LaunchApplication">WIXUI_EXITDIALOGOPTIONALCHECKBOX = 1 And Not Installed</Publish>

Dialog プロパティは、カスタムアクションが結びつくダイアログ、このケースでは ExitDialog 、を指定しています。Control プロパティは、ダイアログの完了ボタンがカスタムアクションのトリガーを引く事を指定しています。Event プロパティは、カスタムアクションはボタンがクリックされた時に実行されるべきである事を指し示し、Value プロパティは、Step 3 でインクルードされたカスタムアクションを指定しています。エレメントでの Condition は、 Step 2 からのチェックボックスがチェックされアプリケーションが(削除されたり修復されるのと対照的に)実際にインストールされていない限り、アクションを実行する事を防ぎます。

完全なサンプル

<?xml version="1.0" encoding="UTF-8"?>
<<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi">
    <Product Id="*"
             UpgradeCode="PUT-GUID-HERE"
             Version="1.0.0.0"
             Language="1033"
             Name="My Application Name"
             Manufacturer="My Manufacturer Name">    
    <Package InstallerVersion="300" Compressed="yes"/>
    <Media Id="1" Cabinet="myapplication.cab" EmbedCab="yes" />

    <!-- 以下の３つのセクションは、"How To: インストーラーにファイルを追加する"トピックからのものです-->
    <Directory Id="TARGETDIR" Name="SourceDir">
        <Directory Id="ProgramFilesFolder">
            <Directory Id="APPLICATIONROOTDIRECTORY" Name="My Application Name"/>
        </Directory>
    </Directory>

    <DirectoryRef Id="APPLICATIONROOTDIRECTORY">
        <Component Id="myapplication.exe" Guid="PUT-GUID-HERE">
            <File Id="myapplication.exe" Source="MySourceFiles\MyApplication.exe" KeyPath="yes" Checksum="yes"/>
        </Component>
        <Component Id="documentation.html" Guid="PUT-GUID-HERE">
            <File Id="documentation.html" Source="MySourceFiles\documentation.html" KeyPath="yes"/>
        </Component>
    </DirectoryRef>

    <Feature Id="MainApplication" Title="Main Application" Level="1">
        <ComponentRef Id="myapplication.exe" />
        <ComponentRef Id="documentation.html" />
    </Feature>

    <!-- Step 2: インストーラーに UI を 追加する / Step 4: カスタム アクションの トリガーを引く -->
    <UI>
        <UIRef Id="WixUI_Minimal" />
        <Publish Dialog="ExitDialog" 
            Control="Finish" 
            Event="DoAction" 
            Value="LaunchApplication">WIXUI_EXITDIALOGOPTIONALCHECKBOX = 1 And Not Installed</Publish>
    </UI>
    <Property Id="WIXUI_EXITDIALOGOPTIONALCHECKBOXTEXT" Value="Launch My Application Name" />

    <!-- Step 3: カスタム アクションを インクルードする -->
    <Property Id="WixShellExecTarget" Value="[#myapplication.exe]" />
    <CustomAction Id="LaunchApplication" 
        BinaryKey="WixCA" 
        DllEntry="WixShellExec"
        Impersonate="yes" />
    </Product>
</Wix>

How To: セットアップ後に インストールしたアプリケーションを 実行する

Step 1: プロジェクトに extension ライブラリーを 追加する

Step 2: インストーラーに UI を 追加する