C# 向け.NET レポートツール
sgcReports は .NET のレポートツールであり C# のレポートジェネレーターです。コードでレポートを作成し、WinForms、WPF、Avalonia で表示し、PDF と Excel にエクスポートできます。
sgcReports は .NET のレポートツールであり C# のレポートジェネレーターです。コードでレポートを作成し、WinForms、WPF、Avalonia で表示し、PDF と Excel にエクスポートできます。
グループ化されたリスト、請求書、テーブル、カタログは、レポートエンジンが一度だけ準備し、プレビューに表示するか、PDF、Excel、CSV、画像に書き出します。
.NET WinForms の ReportTables デモ:ページナビゲーション、ズーム、印刷、PDF、検索、サムネイル、エクスポートを備えたプレビューと、デザイナーおよびテーブルエディターを開くボタン。
グループごとのヘッダー、小計、ページ番号を備えたグループ化レポート。
マスターとディテールのデータから作成した請求書。明細行、合計、QR コード付き。
JSON のレポート定義と、それが描画するページ。アプリケーションを再コンパイルせずにレイアウトを変更できます。
1 つの準備済みレポートから、PDF、Excel ブック、CSV ファイル、ページごとの PNG に書き出します。
レポートデザイナーのテーブルエディター:ヘッダー行、データ行、フッター行、結合セル、スタイル、ハイライト。
DataTable を対象にした TsgcReportDataTableSource でレポートにデータを渡し、流れるようなインターフェースの TsgcReportBuilder でレイアウトを記述して、保存します。ビルダーは、自身のレポートとレポートエンジンを作成して所有します。すべての型は esegece.sgcReports 名前空間にあり、クラス名は Delphi 版と同じです。
using esegece.sgcReports;
public static class SalesReport
{
// aSales: a TsgcReportDataTableSource named "Sales" over a DataTable
// with the columns Region, Customer and Amount, sorted by Region
public static TsgcReportBuilder Build(TsgcReportDataSource aSales)
{
TsgcReportBuilder oBuilder = new TsgcReportBuilder();
oBuilder.Title("Sales by region").Units(TsgcReportUnits.ruMillimeters)
.Style("Group").Font("Arial", 11).Bold().BackColor(0xEEEEEE).EndStyle()
.Page().Paper(TsgcReportPaperSize.rpsA4).Margins(15)
.ReportTitle(14)
.Text("Sales by region", 0, 0, 180, 10).Bold().EndBand()
// one header per region, one line per sale, a total per region
.GroupHeader("Sales.Region", 9).Style("Group")
.Text("Region: [Sales.Region]", 0, 1, 180, 7).EndBand()
.MasterData("Sales", 6)
.Text("[Sales.Customer]", 2, 0, 120, 6)
.Text("[Sales.Amount]", 130, 0, 50, 6).AlignRight().Format("#,0.00").EndBand()
.GroupFooter(9)
.Text("Region total [FormatFloat('#,0.00', Sum(Sales.Amount))]", 80, 1, 100, 6)
.AlignRight().Bold().EndBand()
.EndPage().Data(aSales);
return oBuilder;
}
}
データベースやオブジェクトから DataTable を埋め、データソースに渡してレポートを保存します。PDF 出力は既定でタグ付き PDF/UA となり、同じ準備済みページが Excel と CSV にも出力されます。
using System.Data;
using esegece.sgcReports;
DataTable oTable = new DataTable("Sales");
oTable.Columns.Add("Region", typeof(string));
oTable.Columns.Add("Customer", typeof(string));
oTable.Columns.Add("Amount", typeof(double));
oTable.Rows.Add("East", "Acme Corp", 1450.00);
oTable.Rows.Add("East", "Blue Harbor", 600.00);
oTable.Rows.Add("North", "Nordic Labs", 2100.75);
using (TsgcReportDataTableSource oSales = new TsgcReportDataTableSource())
{
oSales.SourceName = "Sales";
oSales.DataTable = oTable;
using (TsgcReportBuilder oBuilder = SalesReport.Build(oSales))
{
// tagged PDF/UA by default, the same pages as an Excel workbook and a CSV file
oBuilder.SaveToPDF("sales.pdf");
oBuilder.SaveToXLSX("sales.xlsx");
oBuilder.SaveToCSV("sales.csv");
// PDF/A-3 on request, for archiving
oBuilder.PDFExport.PDFA = TsgcReportPDFAMode.rpaA3b;
oBuilder.SaveToPDF("sales-archive.pdf");
// keep the layout as a JSON report definition
sgcReports_Definition.sgcReportSaveToJSONFile(oBuilder.Report, "sales.json");
}
}
ビルダーは、ページヘッダーとフッター、列ヘッダー、ディテールバンド、テーブル、チェックボックス、バーコード、レポートパラメーター、ブックマークも追加できます。TsgcReportBuilder のヘルプトピックとはじめにガイドをご覧ください。
各 UI パッケージには、レポートプレビューと、すぐに使えるエンドユーザー向けレポートデザイナーが含まれるため、ユーザーはアプリケーション内でレポートレイアウトを開き、変更し、保存できます。デザイナーには、ツールバー、Design と Preview のタブ、Toolbox、Outline、Data の各ツリー、プロパティインスペクター、ルーラー、元に戻す、やり直し、スクリプトエディターがあります。3 つのホストは、プラットフォームに依存しない 1 つのデザイナーモデルを共有します。
esegece.sgcReports.WinForms パッケージ:レポートプレビューコントロール、TsgcWinFormsReportDesigner(UserControl)、モーダルの TsgcWinFormsReportDesignerForm、sgcReports_Designer_WinForms.sgcShowReportDesigner。
esegece.sgcReports.Wpf パッケージ:ページナビゲーション、ズーム、印刷、PDF 保存を備えた TsgcWpfReportPreview、TsgcWpfReportDesigner(DockPanel)、モーダルの TsgcWpfReportDesignerWindow。
esegece.sgcReports.Avalonia パッケージ:ページナビゲーション、ズーム、PDF 保存を備えた TsgcAvaloniaReportPreview、TsgcAvaloniaReportDesigner、非同期ファイルピッカーを使う sgcShowReportDesignerAsync。
プレビューには、検索バー、ページサムネイル、PDF アウトライン、11 形式の Export メニュー、長いレポートの準備中に使える Cancel ボタン、レポートパラメーターのプロンプトがあります。プレビューは全エディションに、デザイナークラスは Registered エディションに含まれます。デザイナーは、ReportBuilder の .rtm テンプレートも新しいレポートとしてインポートします。.NET デザイナーのヘルプをご覧ください。
using System.Data;
using System.Windows.Forms;
using esegece.sgcReports;
public class SalesForm : Form
{
TsgcReportDataTableSource FSales;
TsgcReportBuilder FBuilder;
TsgcReportPreviewVCL FPreview;
public SalesForm(DataTable aSales)
{
Width = 1000;
Height = 760;
FSales = new TsgcReportDataTableSource();
FSales.SourceName = "Sales";
FSales.DataTable = aSales;
FBuilder = SalesReport.Build(FSales);
// the preview: page navigation, zoom, find, thumbnails, print and export
FPreview = new TsgcReportPreviewVCL();
FPreview.Dock = DockStyle.Fill;
Controls.Add(FPreview);
Button oDesign = new Button();
oDesign.Text = "Design...";
oDesign.Dock = DockStyle.Top;
oDesign.Click += (s, e) =>
{
// the end-user designer (Registered edition) as a modal window
if (sgcReports_Designer_WinForms.sgcShowReportDesigner(FBuilder.Engine, FSales))
{
sgcReports_Definition.sgcReportSaveToJSONFile(FBuilder.Engine.Report, "sales.json");
FPreview.Prepare();
}
};
Controls.Add(oDesign);
FPreview.Engine = FBuilder.Engine;
FPreview.Prepare();
}
}
using System.Windows;
using esegece.sgcReports;
public class DesignerWindow : Window
{
public DesignerWindow(TsgcReportEngine aEngine, TsgcReportDataSource aSales)
{
Title = "Report designer";
TsgcWpfReportDesigner oDesigner = new TsgcWpfReportDesigner();
Content = oDesigner;
oDesigner.Engine = aEngine;
oDesigner.AddDataSource(aSales);
oDesigner.LoadFromFile("sales.json");
Closed += (s, e) => oDesigner.Dispose();
}
}
public class PreviewWindow : Window
{
public PreviewWindow(TsgcReportEngine aEngine)
{
TsgcWpfReportPreview oPreview = new TsgcWpfReportPreview();
Content = oPreview;
oPreview.Engine = aEngine;
oPreview.Prepare();
}
}
sgcReports はバンド型の C# レポートジェネレーターです。ページがバンドを持ち、バンドがアイテムを持ち、エンジンがデータに応じて適切なタイミングで各バンドを印刷します。
レポートタイトルとサマリー、ページヘッダーとフッター、列ヘッダー、グループヘッダーとフッター、マスターデータとディテールデータのバンド。それぞれが独自の高さ、スタイル、アイテムを持ちます。
グループヘッダーは式が変わるたびに新しいグループを開始し、グループフッターは Sum や Count などの集計関数で小計を印刷します。
請求書が明細行を請求書にリンクするように、MasterSource、MasterFields、DetailFields でディテールソースをマスターにリンクします。
テキストアイテム内の角括弧で囲んだフィールドと関数([Sales.Customer] や [FormatFloat('#,0.00', Sum(Sales.Amount))] など)と、条件が真のときにアイテムのスタイルを変えるハイライト。
ヘッダー行、データ行、フッター行、結合セル、テキストに合わせて伸びる行を持つテーブルアイテムと、複数の指標と合計を持つクロス集計テーブル。
プロンプト付きの型付きレポートパラメーター、レポートに保存される小さなスクリプト言語、レターヘッドなどの基本レイアウトを継承するレポート。
データは、DataTable を対象にした TsgcReportDataTableSource、またはオブジェクトの JSON 配列を対象にした TsgcReportJSONSource から取得します。リッチテキスト、透かし、バーコード、チェックボックス、ブックマークは全エディションに含まれます。チャート、スパークライン、ゲージ、ピボットテーブルのアイテムは、Registered の sgcCharts、sgcGauges、sgcPivotGrid ブリッジパッケージに付属します。sgcReports 機能マトリックスをご覧ください。
エンジンはページを一度だけ準備し、各エクスポートがそれぞれの形式で書き出します。PDF 出力は sgcPDF エンジンを使うため、すべての構成で sgcPDF が必要です。
| 形式 | 詳細 | .NET Community(無料) |
|---|---|---|
| PDF/UA | 既定でタグ付き PDF/UA-1。読み上げ順序、画像の代替テキスト、マーク付き見出しを含みます。PDF/UA-2 は要望に応じて対応します。 | ✓ |
| PDF/A | アーカイブと、請求書 XML を埋め込む電子請求書向けの PDF/A-3(rpaA3b、rpaA3a)と、PDF/A-4。 | ✓ |
| XLSX と CSV | 同じ準備済みページから出力される Excel ブックと CSV ファイル。 | ✓ |
| PNG、SVG、ODS、HTML、テキスト | ページごとの画像、OpenDocument スプレッドシート、HTML、プレーンテキスト。 | ✓ |
| DOCX、ODT、RTF | Word ドキュメント、OpenDocument テキスト、リッチテキスト形式。 | − |
| 署名付き PDF | sgcSign ブリッジパッケージが PDF エクスポートに署名します(PAdES)。 | ✓ |
エンジンとエクスポートは UI を必要としないため、同じレポートを Windows サービス、Web API、Linux デーモンで実行できます。コードまたはデザイナーが保存した JSON レポート定義を読み込み、データを接続してファイルを書き出します。
using System.Data;
using esegece.sgcReports;
public static class ReportJob
{
public static void Run(DataTable aSales, string aFileName)
{
using (TsgcReport oReport = new TsgcReport())
using (TsgcReportEngine oEngine = new TsgcReportEngine())
using (TsgcReportDataTableSource oSales = new TsgcReportDataTableSource())
using (TsgcReportPDFExport oPDF = new TsgcReportPDFExport())
{
// the layout comes from a JSON definition, the data from your code
sgcReports_Definition.sgcReportLoadFromJSONFile(oReport, "sales.json");
oSales.SourceName = "Sales";
oSales.DataTable = aSales;
oEngine.Report = oReport;
oEngine.AddDataSource(oSales);
TsgcReportPreparedPages oPages = oEngine.Prepare();
oPDF.SaveToFile(oPages, aFileName);
}
}
}
TsgcReportHTTPEndpoint は、登録されたレポート(RegisterReport)を PDF、XLSX、CSV、HTML などのファイルとして提供し、esegece.sgcReports.HTML と esegece.sgcReports.AspNetCore パッケージが、そのルートを ASP.NET Core 上でホストします。
サーバーは、スレッドごとに 1 つのエンジンと 1 組のデータソースで、同時実行のレポートを準備します。.NET デモには、LinuxDaemon と HTTPServer のプロジェクトが含まれます。
esegece.sgcReports には、ビルダー、データソース、エンジン、エクスポートが含まれます。プレビューとデザイナー用に UI フレームワークのパッケージを、レポートを Web で提供するために HTML と ASP.NET Core のパッケージを追加します。
dotnet add package esegece.sgcReports
dotnet add package esegece.sgcReports.WinForms
dotnet add package esegece.sgcReports.Wpf
dotnet add package esegece.sgcReports.Avalonia
dotnet add package esegece.sgcReports.AspNetCore
無料の Community エディションには、同じパッケージ ID に .Community サフィックスを付けて使います(例:dotnet add package esegece.sgcReports.Community)。パッケージの一覧は sgcReports ダウンロードページにあり、コンポーネントについては .NET 概要で説明しています。.NET デモは Invoice、Groups、JSONDefinition、PDFUA、Exports、Fluent、HTTPServer、LinuxDaemon、DatabaseSQL、MobileMAUI です。
無料の Community パッケージには、エンジン、エクスポート、プレビューが含まれます。Registered エディションでは、エンドユーザー向けデザイナー、DOCX、ODT、RTF のエクスポート、チャート、ゲージ、ピボットテーブルのブリッジが加わります。
| 機能 | .NET Community(無料) | Registered |
|---|---|---|
| 流れるようなインターフェースのビルダー、レポートモデル、JSON 定義 | ✓ | ✓ |
| バンド、グループ、マスター詳細、式 | ✓ | ✓ |
| PDF/UA と PDF/A-3 のエクスポート | ✓ | ✓ |
| XLSX、CSV、PNG、ODS、SVG、HTML、プレーンテキストのエクスポート | ✓ | ✓ |
| WinForms、WPF、Avalonia のプレビュー | ✓ | ✓ |
| サービスと Linux 向けのヘッドレスエンジン | ✓ | ✓ |
| WinForms、WPF、Avalonia 向けのエンドユーザー向けレポートデザイナー | − | ✓ |
| DOCX、ODT、RTF のエクスポート | − | ✓ |
| チャート、スパークライン、ゲージ、ピボットテーブルのアイテム | − | ✓ |
.Community パッケージは、年間総売上が 100 万ユーロ未満で開発者が 5 名以下の個人および組織は無料で利用できます。いずれかの基準以上の組織には Registered ライセンスが必要です。
すべての機能と商用ライセンス。Single、Team、Site のライセンスがあり、いずれも全ソースコード、1 年間のアップデート、50% から 70% の更新割引が付属します。
sgcReports .NET の価格 →€199
Single、Team、Site ライセンスを用意しています。
はい。sgcReports には、WinForms(esegece.sgcReports.WinForms)、WPF(esegece.sgcReports.Wpf)、Avalonia(esegece.sgcReports.Avalonia)向けのレポートプレビューとエンドユーザー向けレポートデザイナーがあります。プレビューは、ナビゲーション、ズーム、検索、サムネイル、エクスポートを備えてページを表示します。エンジンとエクスポートはコアの esegece.sgcReports パッケージに含まれ、UI なしで動作します。
esegece.sgcReports の NuGet パッケージ(または esegece.sgcReports.Community)を追加し、DataTable を TsgcReportDataTableSource で包み、流れるようなインターフェースの TsgcReportBuilder でページ、バンド、アイテムを記述して、レポート作成サンプルのように SaveToPDF、SaveToXLSX、SaveToCSV を呼び出します。レイアウトを JSON レポート定義から読み込むこともできます。
はい、Registered エディションで可能です。TsgcWinFormsReportDesigner、TsgcWpfReportDesigner、TsgcAvaloniaReportDesigner は自分のウィンドウに配置できるデザイナーで、sgcShowReportDesigner はモーダルウィンドウとして開きます。ユーザーはアイテムやフィールドをバンドにドラッグし、プロパティ、テーブル、スクリプトを編集し、結果をプレビューして、サーバーがヘッドレスで実行できる JSON 定義としてレイアウトを保存できます。
はい。SaveToPDF は既定でタグ付き PDF/UA を書き出し、PDFExport.PDFA で PDF/A-3 に切り替わり、SaveToXLSX は同じ準備済みページから Excel ブックを書き出します。CSV、PNG、SVG、ODS、HTML、プレーンテキストは全エディションに、DOCX、ODT、RTF は Registered エディションに含まれます。
はい。ヘッドレスエンジンとエクスポートは、Windows と Linux のサービスやデーモンで動作し、.NET デモには LinuxDaemon プロジェクトが含まれます。Web 向けには、esegece.sgcReports.AspNetCore パッケージがレポートエンドポイントを ASP.NET Core に統合し、PDF、XLSX、CSV、HTML などのファイルとしてレポートを提供します。
はい。sgcReports の NuGet パッケージはすべて、エンジン、エクスポート、プレビューを備えた無料の Community エディションとして、.Community サフィックス付きでも提供されます。年間総売上が 100 万ユーロ未満で開発者が 5 名以下の個人および組織は無料で利用できます。エンドユーザー向けデザイナーと DOCX、ODT、RTF のエクスポートには Registered ライセンスが必要です。sgcReports の価格をご覧ください。