ASP.NET 2.0 での ReportViewer コントロールの使用

著者：Eve Cole 更新時間：2009-07-01 16:43:40

この記事の翻訳: webabcd

導入

データ駆動型アプリケーションの共通要件はレポートです。ただし、この非常に重要な機能は ASP.NET 1.x では提供されていません。ただし幸いなことに、.NET 2.0 に付属の ReportViewer コントロールは、レポートの基本的なニーズの一部を満たすことができます。この記事では、このコントロールの使用方法を説明します。 ReportViewer コントロールは、Web プログラムと Windows プログラムの両方で使用できます。ここではWebプログラムでの使い方のみを紹介します。

レポート例

以下に示すような顧客情報リストを生成するとします。

上記のレポートは、国ごとにグループ化された顧客情報の非常に単純なリストです。レポートのデータは、Northwind データベースの Customers テーブルから取得されます。デフォルトでは、すべての顧客情報が表示されます。ただし、指定した国に属する顧客に関する情報を表示させることもできます。

レポートは ReportViewer コントロールを使用して設計されており、厳密に型指定された DataSet またはカスタムオブジェクトコレクションからデータを取得できます。実際のプログラム開発では3層アーキテクチャを採用することが多く、取得されるデータはビジネス層から取得したDataSetや汎用コレクションであることが多いです。ここでは、厳密に型指定された DataSet の代わりに、汎用コレクションをデータソースとして使用する予定です。

クラスライブラリを作成する

まず、Visual Studio を開き、ReportViewerLib というクラスライブラリプロジェクトを作成します。以下に示すように、Customer という名前のクラスを追加します。

システムを使用する;
System.Data を使用します。
System.Configuration を使用します。
System.Data.SqlClient を使用します。
System.Collections.Generic を使用します。
名前空間 ReportViewerLib
{
パブリッククラス顧客
{
パブリック文字列 strCustomerID;
パブリック文字列 strCompanyName;
パブリック文字列 strContactName;
パブリック文字列 str Country;

パブリック文字列顧客ID
{
得る
{
strCustomerID を返します。
}
セット
{
strCustomerID = 値;
}
}

パブリック文字列会社名
{
得る
{
strCompanyName を返します。
}
セット
{
strCompanyName= 値;
}
}

パブリック文字列連絡先名
{
得る
{
strContactName を返します。
}
セット
{
strContactName= 値;
}
}

パブリック文字列国
{
得る
{
str国を返します。
}
セット
{
str国=値;
}
}

パブリック静的リスト

GetCustomersFor Country(文字列国)
{
SqlConnection cnn=new SqlConnection(
ConfigurationManager.ConnectionStrings["NorthwindConnectionString"].ConnectionString);
SqlCommand cmd=new SqlCommand();
cmd.Connection=cnn;
cmd.CommandText="選択
顧客ID、会社名、連絡先名、国
country=@country"; の顧客から。
SqlParameter p=新しい SqlParameter
("@国",国);
cmd.Parameters.Add(p);
cnn.Open();
SqlDataReader リーダー = cmd.ExecuteReader();
リスト

list = 新しいリスト

();
while (reader.Read())
{
顧客 c = 新しい顧客();
c.CustomerID = Reader.GetString(0);
c.CompanyName = Reader.GetString(1);
c.ContactName = Reader.GetString(2);
c.国 = リーダー.GetString(3);
list.Add(c);
}
cnn.Close();
リストを返す;
}

パブリック静的リスト

GetAllCustomers()
{
SqlConnection cnn = 新しい SqlConnection(
ConfigurationManager.ConnectionStrings
["NorthwindConnectionString"].ConnectionString);
SqlCommand cmd = new SqlCommand();
cmd.Connection = cnn;
cmd.CommandText = "選択
顧客ID、会社名、連絡先名、顧客の国";
cnn.Open();
SqlDataReader リーダー = cmd.ExecuteReader();
リスト

list = 新しいリスト

Customer クラスは、CustomerID、CompanyName、ContactName、および Country という 4 つのパブリックプロパティを定義します。その後、このクラスには 2 つの静的メソッド、GetCustomersForContry() と GetAllCustomers() が含まれます。これら 2 つのメソッドは比較的単純です。1 つは特定の国に属するすべての顧客情報を返し、もう 1 つはすべての顧客情報を返します。まず Northwind データベースへの接続を開いてから、SqlCommand オブジェクトを通じて SELECT クエリを実行します。その後、SqlDataReader オブジェクトを使用してデータを取得します。この SqlDataReader オブジェクトを走査し、その中に毎回 Customer オブジェクトを作成し、そのさまざまなプロパティを設定して、最後に Customer オブジェクトの汎用コレクションに追加します。クラスの最後に、Customer オブジェクトの汎用コレクションが呼び出し元に返されます。
データソースの作成

レポートをデザインするときは、プロジェクト内でレポートのデータソースを指定する必要があります。プロジェクトにデータソースを追加するには、[データ] メニュー -> [新しいデータソースの追加] を選択します。次に、以下に示すダイアログボックスが表示されます。

データソースは、データベース、Web サービス、またはオブジェクトです。この場合は、「オブジェクト」を選択しました。次に、[次へ] ボタンをクリックすると、データソースを選択するためのインターフェイスがポップアップ表示されます。ここでは Customer クラスを選択しました (次の図を参照)。

[完了] ボタンをクリックしてデータソース構成ウィザードを完了します。このようにして、新しいデータソースをクラスライブラリに追加しました。データソースを表示したい場合は、[データ] メニュー -> データソースの表示を選択すると、次のようなインターフェイスが表示されます。

設計レポート

次にレポートを追加します。プロジェクトを右クリックし、「新しい項目の追加」を選択します。ダイアログボックスで「レポート」を選択し、「追加」ボタンをクリックします（下図を参照）。このようにして、「Report1.rdlc」という名前のファイルが追加されました。 .rdlc ファイルは、レポートレイアウトとデータマッピングを保存するレポートファイルです。

Report1.rdlc ファイルを開くと、レポート関連のコントロールのセットが Visual Studio ツールボックスに表示されます (以下を参照)。

これらのコントロールの中でも、「テキストボックス」コントロールと「テーブル」コントロールがよく使用されます。「テキストボックス」コントロールは、静的テキストまたは式を表示するために使用されます。「表」コントロールは表形式のデータを表示するために使用され、それによって生成された結果はレポートの「本文」に表示されます。

設計されたレポートを以下に示します。

レポートの「ヘッダー」セクションの先頭には、値プロパティが「顧客リスト」であるテキストボックスがあります。このテキストボックスの下には別のテキストボックスがあり、その Value プロパティの値は「=Parameters!SubTitle.Value」です。これは、テキストボックスの値が SubTitle という名前のパラメーターから取得されることを意味します。パラメーターを定義するにはどうすればよいですか? これには、レポートの ReportParameters プロパティにパラメーターを追加する必要があります。開いたレポートパラメーターダイアログボックスを次の図に示します。

注意: パラメータの設定は .NET コードで行われます。

レポートに日付を表示したい場合は、関連するテキストボックスの Value プロパティを「=FormatDateTime(ToDay(),DateFormat.ShortDate)」に設定するだけです。レポートの大きな利点の 1 つは、ToDay() や FormatDateTime などの多くの組み込み関数があることです。この例では、FormatDateTime() 関数を使用して、現在の日付 (ToDay()) を ShortDate 形式で表示します。

次に、「テーブル」コントロールをツールボックスからレポートにドラッグします。デフォルトでは、「テーブル」コントロールには 3 行 3 列があり、その 3 行はテーブルヘッダー、詳細情報、テーブルフッターです。もちろん、Table コントロールに行と列を追加することもできます。 CustomerID、CompanyName、ContactName、および Country プロパティをデータソースウィンドウからテーブルコントロールの詳細行にドラッグします。このようにして、システムは自動的にテキストボックスを追加し、そのプロパティを =Fields!CustomerID.Value、=Fields!CompanyName.Value などに設定します。この時点で、列ヘッダーも自動的に追加されます。もちろん、ニーズに応じて必要な修正を行うこともできます。

次に、顧客が属する国ごとにレコードをグループ化します。詳細行の境界線を右クリックし、[グループの挿入] を選択します (下の図を参照)。

次に、以下に示すダイアログボックスが表示されます。

「並べ替え」タブで、式として「=Fields! Country.Value」を選択し、並べ替え方向として「昇順」を選択します。

とてもシンプルなことです。このようにして、レポートのデザインが完成しました。
レポートを表示する

「ReportViewerDemo」という名前の新しい Web サイトを作成します。 ReportViewerLib アセンブリへの参照を追加して、アセンブリが Web サイトの BIN ディレクトリにコピーされるようにします。その後、Report1.rdlc ファイルを Web サイトに追加します。ツールボックスの [データ] タブにある ReportViewer コントロールを Default.aspx ページにドラッグし、ReportViewer コントロールのスマートタグパネルを開き、[レポートの選択] ドロップダウンボックスで Report1.rdlc を選択します。下の図：

レポートファイルを選択すると、TypeName プロパティが Customer であるオブジェクトデータソースコントロールがシステムによって自動的に追加されます。これは、オブジェクトデータソースコントロールの構成ウィザードで確認できます。

次に、DropDownList コントロールをページのヘッダーにドラッグし、All、USA、UK、Brazil の 4 つのオプションを設定します。また、AutoPostBack プロパティを True に設定します。次に、データソースコントロールの構成ウィザードを開き、「SELECT」操作を SelectCustomersFor Country() メソッドに設定します。

SelectCustomersFor Country() メソッドの国パラメータを DropDownList1 の SelectedValue に設定します。

デフォルトでは、すべての顧客情報がレポートに表示されます。ドロップダウンリストで国を選択すると、選択した国に属する顧客情報がレポートに表示されます。このような関数を完了するには、DropDownList の SelectedIndexChanged イベントを処理するだけで済みます。

protected void DropDownList1_SelectedIndexChanged
(オブジェクト送信者、EventArgs e)
{
if (DropDownList1.SelectedValue == "すべて")
{
ObjectDataSource1.SelectMethod = "GetAllCustomers";
ObjectDataSource1.SelectParameters.Clear();
ReportParameter パラメータ = 新しい ReportParameter
("サブタイトル"、"全顧客リスト");
ReportParameter[] p ={ パラメータ };
ReportViewer1.LocalReport.SetParameters(p);
}
それ以外
{
ObjectDataSource1.SelectMethod = "GetCustomersFor Country";
ObjectDataSource1.SelectParameters[0].DefaultValue
= DropDownList1.SelectedValue;

ReportParameter パラメータ = 新しい ReportParameter
(「サブタイトル」、「国の顧客リスト」);
ReportParameter[] p ={ パラメータ };
ReportViewer1.LocalReport.SetParameters(p);
}
}

このコードは、最初に DropDownList コントロールの SelectedValue プロパティをチェックします。「All」の場合は、データソースコントロールの SelectMethod プロパティを GetAllCustomers に設定します。さらに、GetAllCustomers() メソッドにはパラメーターが必要ないため、SelectParameters コレクションもクリアする必要があります。次に、ReportParameter クラスのインスタンスを作成し、そのコンストラクターにレポートのパラメーター名と値を設定します。レポートの設計時に定義したパラメーターを思い出してください。次に、ReportParameter 配列を作成します。この配列をパラメータとして SetParameters() メソッドを呼び出します。「else」コードブロックも非常に単純です。つまり、使用されるメソッドは GetCustomersFor Country() になります。

とてもシンプルなことです。報告書が完成しました。 Default.aspx ページを実行して効果を確認できます。 ReportViewer コントロールにはエクスポート機能が組み込まれており、レポートを Excel または PDF 形式にエクスポートできることに注意してください。 ReportViewer コントロールには多くのプロパティもあり、自分で調べることができます。

要約する

ASP.NET の ReportViewer コントロールは、レポートの多くの基本機能を提供します。この記事では、オブジェクトデータソースコントロールを使用してレポートを開発します。クラスライブラリとデータソースを作成しました。最後に、ReportViewer コントロールを使用してレポートを表示します。