チュートリアル: プライバシー プロンプトを表示するためのカスタム ブートストラップの作成
ClickOnce アプリケーションは、アセンブリに含まれるファイルおよびアセンブリの新しいバージョンが利用できるようになったときに自動的に更新されるように構成できます。 この動作に同意することをユーザーに確認するには、プライバシー プロンプトを表示します。 このプロンプトで、ユーザーはアプリケーションの自動更新を許可するかどうかを選択できます。 アプリケーションの自動更新が許可されなかった場合、インストールは行われません。
注意
お使いのマシンで、Visual Studio ユーザー インターフェイスの一部の要素の名前や場所が、次の手順とは異なる場合があります。 これらの要素は、使用している Visual Studio のエディションや独自の設定によって決まります。 詳細については、「Visual Studio の設定」を参照してください。
必須コンポーネント
このチュートリアルを実行するには、次のコンポーネントが必要です。
- Visual Studio 2010
更新の同意を求めるダイアログ ボックスを作成する
プライバシー プロンプトを表示するには、アプリケーションの自動更新についてユーザーの同意を求めるアプリケーションを作成します。
同意を求めるダイアログ ボックスを作成するには
[ファイル] メニューの [新規作成] をポイントし、[プロジェクト] をクリックします。
[新しいプロジェクト] ダイアログ ボックスで、[ウィンドウ] をクリックし、[Windows フォーム アプリケーション] をクリックします。
[名前] に「ConsentDialog」と入力し、[OK] をクリックします。
デザイナーでフォームをクリックします。
[プロパティ] ウィンドウで、Text プロパティを「Update Consent Dialog」に変更します。
ツールボックスで [すべての Windows フォーム] を展開し、Label コントロールをフォームにドラッグします。
デザイナーでラベル コントロールをクリックします。
[プロパティ] ウィンドウで、Appearance の Text プロパティを次のように変更します。
インストールしようとしているアプリケーションでは、Web で最新の更新プログラムがチェックされます。 [同意する] をクリックして承認すると、インターネットに接続して自動的に更新プログラムの確認とインストールが行われます。
ツールボックスの Checkbox コントロールをフォームの中央にドラッグします。
[プロパティ] ウィンドウで、Layout の Text プロパティを「同意する」に変更します。
ツールボックスの Button コントロールをフォームの左下へドラッグします。
[プロパティ] ウィンドウで、Layout の Text プロパティを「続行」に変更します。
[プロパティ] ウィンドウで、Design の (Name) プロパティを「ProceedButton」に変更します。
ツールボックスの Button コントロールをフォームの右下へドラッグします。
[プロパティ] ウィンドウで、Layout の Text プロパティを「キャンセル」に変更します。
[プロパティ] ウィンドウで、Design の (Name) プロパティを「CancelButton」に変更します。
デザイナーで、[同意する] チェック ボックスをダブルクリックして、CheckedChanged イベント ハンドラーを生成します。
Form1 コード ファイルで、CheckedChanged イベント ハンドラーに次のコードを追加します。
Private Sub CheckBox1_CheckedChanged(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles CheckBox1.CheckedChanged ProceedButton.Enabled = Not ProceedButton.Enabled End Sub
private void checkBox1_CheckedChanged(object sender, EventArgs e) { ProceedButton.Enabled = !ProceedButton.Enabled; }
クラス コンストラクターを更新して、[続行] ボタンを既定で無効にします。
Public Sub New() InitializeComponent() ProceedButton.Enabled = False End Sub
public Form1() { InitializeComponent(); ProceedButton.Enabled = false; }
Form1 コード ファイルで、エンド ユーザーがオンライン更新に同意したかどうかをブール変数で追跡するために次のコードを追加します。
Public accepted As Boolean = False
public bool accepted = false;
デザイナーで、[続行] ボタンをダブルクリックして、Click イベント ハンドラーを生成します。
Form1 コード ファイルで、[続行] ボタンの Click イベント ハンドラーに次のコードを追加します。
Private Sub ProceedButton_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles ProceedButton.Click If ProceedButton.Enabled Then accepted = True Me.Close() End If End Sub
private void ProceedButton_Click(object sender, EventArgs e) { if (ProceedButton.Enabled) { accepted = true; this.Close(); } }
デザイナーで、[キャンセル] ボタンをダブルクリックして、Click イベント ハンドラーを生成します。
Form1 コード ファイルで、[キャンセル] ボタンの Click イベント ハンドラーに次のコードを追加します。
Private Sub CancelButton_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles CancelButton.Click Me.Close() End Sub
private void CancelButton_Click(object sender, EventArgs e) { this.Close(); }
アプリケーションを更新して、エンド ユーザーがオンライン更新に同意しなかった場合にエラーを返すようにします。
Visual Basic 開発者用の手順は次のとおりです。
ソリューション エクスプローラーで、[ConsentDialog] をクリックします。
[プロジェクト] メニューの [モジュールの追加] をクリックし、[追加] をクリックします。
Module1.vb コード ファイルで、次のコードを追加します。
Module Module1 Function Main() As Integer Application.EnableVisualStyles() Application.SetCompatibleTextRenderingDefault(False) Dim f As New Form1() Application.Run(f) If (Not f.accepted) Then Return -1 Else Return 0 End If End Function End Module
[プロジェクト] メニューの [ConsentDialog のプロパティ] をクリックし、[アプリケーション] タブをクリックします。
[アプリケーション フレームワークを有効にする] チェック ボックスをオフにします。
[スタートアップ オブジェクト] ドロップダウン メニューの [Module1] を選択します。
注意
アプリケーション フレームワークを無効にすると、Windows XP の視覚スタイル、アプリケーション イベント、スプラッシュ スクリーン、単一インスタンス アプリケーションなどの機能は無効になります。 詳細については、「[アプリケーション] ページ (プロジェクト デザイナー) (Visual Basic)」を参照してください。
C# 開発者用の手順は次のとおりです。
Program.cs コード ファイルを開いて、次のコードを追加します。
static int Main() { Application.EnableVisualStyles(); Application.SetCompatibleTextRenderingDefault(false); Form1 f = new Form1(); Application.Run(f); if (!f.accepted) return -1; else return 0; }
[ビルド] メニューの [ソリューションのビルド] をクリックします。
カスタム ブートストラップ パッケージを作成する
エンド ユーザーにプライバシー プロンプトを表示するには、更新の同意を求めるダイアログを表示するアプリケーションのカスタム ブートスラップ パッケージを作成し、必須コンポーネントとしてすべての ClickOnce アプリケーションに含めます。
ここでは、次のドキュメントを作成してカスタム ブートストラップ パッケージを作成する方法を示します。
ブートスラップの内容を記述した product.xml マニフェスト ファイル。
パッケージのローカリゼーション固有の特性 (文字列、ソフトウェア ライセンス条項など) を記述した package.xml マニフェスト ファイル。
ソフトウェア ライセンス条項のドキュメント。
手順 1: ブートストラップ ディレクトリを作成するには
UpdateConsentDialog という名前のディレクトリを %PROGRAMFILES%\Microsoft SDKs\Windows\v7.0A\Bootstrapper\Packages に作成します。
注意
このフォルダーを作成するには、管理者特権が必要な場合があります。
UpdateConsentDialog ディレクトリに「en」という名前のサブディレクトリを作成します。
注意
ロケールごとに新しいディレクトリを作成します。 たとえば、fr および de のロケールのサブディレクトリを作成し、 必要に応じて、フランス語とドイツ語の文字列や言語パックを含めることができます。
手順 2: product.xml マニフェスト ファイルを作成するには
product.xml というテキスト ファイルを作成します。
product.xml ファイルに次の XML コードを追加します。 既存の XML コードは上書きしないように注意してください。
<Product xmlns="https://schemas.microsoft.com/developer/2004/01/bootstrapper" ProductCode="Microsoft.Sample.EULA"> <!-- Defines the list of files to be copied on build. --> <PackageFiles CopyAllPackageFiles="false"> <PackageFile Name="ConsentDialog.exe"/> </PackageFiles> <!-- Defines how to run the Setup package.--> <Commands > <Command PackageFile = "ConsentDialog.exe" Arguments=''> <ExitCodes> <ExitCode Value="0" Result="Success" /> <ExitCode Value="-1" Result="Fail" String="AU_Unaccepted" /> <DefaultExitCode Result="Fail" FormatMessageFromSystem="true" String="GeneralFailure" /> </ExitCodes> </Command> </Commands> </Product>
ファイルを UpdateConsentDialog ブートストラップ ディレクトリに保存します。
手順 3: package.xml マニフェスト ファイルとソフトウェア ライセンス条項を作成するには
package.xml というテキスト ファイルを作成します。
package.xml ファイルに次の XML コードを追加して、ロケールを定義し、ソフトウェア ライセンス条項を含めます。 既存の XML コードは上書きしないように注意してください。
<Package xmlns="https://schemas.microsoft.com/developer/2004/01/bootstrapper" Name="DisplayName" Culture="Culture" LicenseAgreement="eula.rtf"> <PackageFiles> <PackageFile Name="eula.rtf"/> </PackageFiles> <!-- Defines a localizable string table for error messages. --> <Strings> <String Name="DisplayName">Update Consent Dialog</String> <String Name="Culture">en</String> <String Name="AU_Unaccepted">The automatic update agreement is not accepted.</String> <String Name="GeneralFailure">A failure occurred attempting to launch the setup.</String> </Strings> </Package>
ファイルを UpdateConsentDialog ブートストラップ ディレクトリの en サブディレクトリに保存します。
eula.rtf というソフトウェア ライセンス条項のドキュメントを作成します。
注意
ソフトウェア ライセンス条項には、ライセンス、保証、責任、法律などに関する情報を含めます。 これらのファイルはロケール固有の内容にする必要があるため、MBCS または UNICODE の文字をサポートするファイル形式で保存します。 ソフトウェア ライセンス条項の内容については、法務部に確認してください。
ドキュメントを UpdateConsentDialog ブートストラップ ディレクトリの en サブディレクトリに保存します。
必要に応じて、ロケールごとに新しい package.xml マニフェスト ファイルと新しいソフトウェア ライセンス条項の eula.rtf ドキュメントを作成します。 たとえば、fr と de のロケールのサブディレクトリを作成した場合、それぞれの package.xml マニフェスト ファイルとソフトウェア ライセンス条項を作成し、fr サブディレクトリと de サブディレクトリにそれぞれ保存します。
更新の同意を求めるアプリケーションを必須コンポーネントとして設定する
Visual Studio で、更新の同意を求めるアプリケーションを必須コンポーネントとして設定できます。
更新の同意を求めるアプリケーションを必須コンポーネントとして設定するには
ソリューション エクスプローラーで、配置するアプリケーションの名前をクリックします。
[プロジェクト] メニューの [ProjectName のプロパティ] をクリックします。
[発行] ページをクリックし、[必須コンポーネント] をクリックします。
[Update Consent Dialog] を選択します。
注意
Visual Studio をいったん閉じて開き直さないと [必須コンポーネント] ダイアログ ボックスに Update Consent Dialog が表示されない場合があります。
[OK] をクリックします。
セットアップ プログラムを作成してテストする
更新の同意を求めるアプリケーションを必須コンポーネントとして設定したら、アプリケーションのインストーラーとブートストラップを生成できます。
セットアップ プログラムを作成して [同意する] をクリックしない場合の動作をテストするには
ソリューション エクスプローラーで、配置するアプリケーションの名前をクリックします。
[プロジェクト] メニューの [ProjectName のプロパティ] をクリックします。
[発行] ページをクリックし、[今すぐ発行] をクリックします。
発行の出力が自動的に開かない場合は発行の出力に移動します。
Setup.exe プログラムを実行します。
セットアップ プログラムで、Update Consent Dialog のソフトウェア ライセンス条項が表示されます。
ソフトウェア ライセンス条項を読み、[同意する] をクリックします。
Update Consent Dialog アプリケーションが表示され、"インストールしようとしているアプリケーションでは、Web で最新の更新プログラムがチェックされます。 [同意する] をクリックして承認すると、インターネットに接続して自動的に更新プログラムの確認とインストールが行われます。" というテキストが表示されます。
アプリケーションを閉じるか、[キャンセル] をクリックします。
アプリケーションで、"ApplicationName のシステム コンポーネントのインストール中にエラーが発生しました。 すべてのシステム コンポーネントが正常にインストールされるまで、セットアップは続行できません。" というエラーが表示されます。
[詳細] をクリックします。"コンポーネント Update Consent Dialog のインストールに失敗し、次のエラー メッセージが生成されました: "The automatic update agreement is not accepted." 次のコンポーネントをインストールできませんでした: - Update Consent Dialog" というエラー メッセージが表示されます。
[閉じる] をクリックします。
セットアップ プログラムを作成して [同意する] をクリックした場合の動作をテストするには
ソリューション エクスプローラーで、配置するアプリケーションの名前をクリックします。
[プロジェクト] メニューの [ProjectName のプロパティ] をクリックします。
[発行] ページをクリックし、[今すぐ発行] をクリックします。
発行の出力が自動的に開かない場合は発行の出力に移動します。
Setup.exe プログラムを実行します。
セットアップ プログラムで、Update Consent Dialog のソフトウェア ライセンス条項が表示されます。
ソフトウェア ライセンス条項を読み、[同意する] をクリックします。
Update Consent Dialog アプリケーションが表示され、"インストールしようとしているアプリケーションでは、Web で最新の更新プログラムがチェックされます。 [同意する] をクリックして承認すると、インターネットに接続して自動的に更新プログラムの確認とインストールが行われます。" というテキストが表示されます。
[同意する] をクリックし、[続行] をクリックします。
アプリケーションでインストールが開始されます。
[アプリケーションのインストール] ダイアログ ボックスで、[インストール] をクリックします。