Delphi 向けレポートビルダー:ビジュアルまたはコードでレポートを設計
sgcReports は Delphi と C++ Builder 向けのレポートビルダーです。ユーザーはビジュアルにレポートを設計でき、コードからは流れるようなインターフェースの TsgcReportBuilder クラスで組み立てられます。
sgcReports は Delphi と C++ Builder 向けのレポートビルダーです。ユーザーはビジュアルにレポートを設計でき、コードからは流れるようなインターフェースの TsgcReportBuilder クラスで組み立てられます。
レポートは、ページ、バンド、アイテム、スタイル、データソースのモデルです。デザイナーとコードの両方がこのモデルを編集し、JSON 定義として保存されます。
ユーザーは VCL、FireMonkey、または Web のレポートデザイナーでビジュアルにレポートを設計でき、コードからは流れるようなインターフェースの TsgcReportBuilder クラスで組み立てられます。どちらもバンド、グループ、マスター詳細、式を備えた同じレポートモデルを生成し、プレビュー、印刷、PDF、Excel、CSV などへのエクスポートが、デスクトップでもウィンドウのないサービスでも行えます。
TsgcVCLReportDesigner または TsgcFMXReportDesigner をフォームに配置するか、TsgcReportHTMLDesigner をブラウザー向けに提供します。ユーザーはフィールドをバンドにドラッグし、インスペクターでプロパティを設定し、ライブプレビューに切り替えられます。Registered
TsgcReportBuilder は、スタイル、ページ、バンド、アイテムを 1 本のメソッドチェーンで記述します。レポートはプロジェクトの他の部分と一緒にコンパイル、差分比較、リファクタリングでき、匿名メソッドなしで Delphi 7 から動作します。
sgcReportSaveToJSONFile でレポートを保存し、実行時に読み込めます。そのため、レイアウトをデータベースや顧客のフォルダーに置き、再ビルドなしで変更できます。デザイナーも同じファイルを開いて保存します。
ユーザーがアプリケーション内で実行できるエンドユーザー向けレポートデザイナーと、IDE のデザイン時に使える同じデザイナーです。
レポートデザイナー Registered のみ
TsgcVCLReportDesigner は、ツールバー、Toolbox、Outline、Data の各タブ、ルーラー付きのデザインサーフェス、プロパティインスペクター、Design と Preview のタブを備えたパネルです。フォームに配置して Engine を割り当て、データソースを追加すると、ユーザーはレポートを編集し、JSON 定義として保存し、ライブデータでプレビューできます。TsgcFMXReportDesigner は同じデザイナーユニットを基にした FireMonkey 版です。
TsgcReportEngine を右クリックして Design report… を選ぶと、同じデザイナーでそのレポートを編集できますフォームの作成時にデザイナーをエンジンとデータソースに接続し、最後に保存したレイアウトを読み込みます:
procedure TfrmMain.FormCreate(Sender: TObject);
begin
sgcDesigner.Engine := sgcEngine;
sgcDesigner.AddDataSource(sgcOrders);
if FileExists('orders.json') then
sgcDesigner.LoadFromFile('orders.json')
else
sgcDesigner.NewReport;
end;
procedure TfrmMain.FormCloseQuery(Sender: TObject; var CanClose: Boolean);
begin
if sgcDesigner.Modified then
sgcDesigner.SaveToFile('orders.json');
end;専用のフォームなしでメニューからレポートを編集するには、sgcShowReportDesigner(VCL)または sgcShowReportDesignerFMX(FireMonkey、Windows と macOS)が、OK と Cancel ボタン付きでデザイナーをモーダル表示し、ユーザーがキャンセルするとレポートを元の状態に戻します:
procedure TfrmMain.mnuEditReportClick(Sender: TObject);
begin
if sgcShowReportDesigner(sgcEngine) then
sgcReportSaveToJSONFile(sgcEngine.Report, 'orders.json');
end;TsgcFMXReportDesigner(Delphi XE6 以降)は、同じツールバー、ツリー、サーフェス、インスペクター、プレビュータブを備え、TsgcReportPreviewFMX をホストします。ToolbarButtonSize を使うと、タッチスクリーンでボタンをタップしやすくなります。モーダルフォームとファイルダイアログは Windows と macOS で利用できます。
TsgcReportHTMLDesigner は、バンドキャンバス、プロパティインスペクター、ライブプレビューを使って JSON 定義をブラウザー上で編集します。完成したレポートと同じ HTTP エンドポイントから提供されます。sgcWebSockets Professional 以上と sgcHTML が必要です。本番のエンドポイントでは DesignerEnabled をオフのままにし、独自の認証の背後に置いてください。
.NET 版 sgcReports には、WinForms、WPF、Avalonia 向けのエンドユーザーデザイナーが含まれます。TsgcVCLReportDesigner に相当するもので、ツールバー、ツリー、インスペクター、プレビューも同じです。JSON 定義の読み込みと保存にも対応しています。
任意の TDataSet を対象にしたグループ化売上レポート。地域ごとのヘッダー、売上ごとの明細行、地域ごとの小計、ページフッターを備え、PDF と Excel で保存します。
uses
Classes, SysUtils, DB,
sgcReports_Types, sgcReports_Model, sgcReports_Data, sgcReports_Fluent;
const
CS_TOTAL = '[FormatFloat(''#,0.00'', Sum(Sales.Amount))]';
procedure ExportSalesReport(aSales: TDataSet; const aFolder: string);
var
oSales: TsgcReportDataSetSource;
oBuilder: TsgcReportBuilder;
begin
oSales := TsgcReportDataSetSource.Create(nil);
oBuilder := TsgcReportBuilder.Create;
try
// any TDataSet: FireDAC, TClientDataSet, dbExpress...
oSales.SourceName := 'Sales';
oSales.DataSet := aSales;
oBuilder.Title('Sales by region').Units(ruMillimeters)
.Style('Base').Font('Arial', 10).EndStyle
.Style('Group').Font('Arial', 11).Bold.BackColor($EEEEEE).EndStyle
.Page.Paper(rpsA4).Margins(15)
.GroupHeader('Sales.Region', 9).Style('Group')
.Text('Region: [Sales.Region]', 0, 1, 180, 7).TagRole(rtrHeading2).EndBand
.MasterData('Sales', 6).Style('Base')
.Text('[Sales.Customer]', 2, 0, 120, 6)
.Text('[Sales.Amount]', 130, 0, 50, 6).AlignRight.Format('#,0.00').EndBand
.GroupFooter(9).Style('Base')
.Text('Region total ' + CS_TOTAL, 80, 1, 100, 6).AlignRight.Bold.EndBand
.PageFooter(8).Style('Base')
.Text('Page [Page] of [TotalPages]', 0, 1, 180, 6).AlignCenter.EndBand
.EndPage.Data(oSales);
oBuilder.SaveToPDF(IncludeTrailingPathDelimiter(aFolder) + 'sales.pdf');
oBuilder.SaveToXLSX(IncludeTrailingPathDelimiter(aFolder) + 'sales.xlsx');
finally
oBuilder.Free;
oSales.Free;
end;
end;Style、Page、GroupHeader、MasterData、GroupFooter、PageFooter は、生成されるレイアウトそのままに読めますSaveToPDF、SaveToXLSX、SaveToCSV、SaveToPNG はビルダーから直接準備とエクスポートを行い、SaveToPDFStream などのストリーム版は Web レスポンスに使えますTsgcReport モデルを埋めます。このモデルは Report として利用でき、Engine はプレビューに接続します本格的なバンド型レイアウトなので、地域別売上や顧客別請求書のような業務レポートも回避策なしで作成できます。
バンドとグループ
レポートには、レポートタイトル、ページヘッダー、グループヘッダー、データ、グループフッター、ページフッター、サマリーの各バンドに加え、列ヘッダーと列フッターがあります。グループは式が変わると区切られ、独自の合計を出力し、新しいページから始めたり、すべてのページでヘッダーを繰り返したりできます。サブレポートを使うと、1 ページに別のレイアウトを含められます。
GroupExpression と、2 段階以上にするための入れ子のグループStartNewPage、RepeatOnEveryPage、KeepTogether がページの流れを制御しますPrintOnFirstPage と PrintOnLastPage がページバンドを表示する位置を決めます式
すべてのテキストアイテムは角括弧で式を記述でき、エンジンが行ごとに評価するため、フッターの合計は常に上に印刷された明細と一致します。日付演算、パディングと書式設定、12 言語の ToWords、条件付き集計、グループごとにリセットされる累計など、68 の関数と 10 の集計関数があります。
'[Sum(Lines.Qty * Lines.Price)]'
'[FormatDateTime(''dd/mm/yyyy'', Invoices.Date)]'
'Page [Page] of [TotalPages]'Sum、FormatFloat、FormatDateTime、Upper、Round、IsNull、SumIf、CountIf、RunningSum、PreviousOnGetVariable は実行時に独自の変数を提供しますHighlights は条件が真のときにスタイルを適用します。たとえば、スクリプトなしで負の金額を赤にできますレポートは、データのある場所から直接読み取ります。クエリ、JSON ドキュメント、独自のオブジェクトのいずれでも構いません。
マスター詳細
TsgcReportDataSetSource は、TClientDataSet、FireDAC、dbExpress など、任意の TDataSet を読み取ります。詳細ソースはキーフィールドでマスターにリンクされるため、各請求書が自分の明細行を印刷し、グループフッターが合計を計算します。開かれていないデータセットは実行前後で開閉され、すでに開いているデータセットは、実行後に状態と位置が復元されます。
MasterSource、MasterFields、DetailFields がソース同士をリンクしますTsgcReportJSONSource は JSON 文字列またはファイルを読み取り、RecordsPath が配列を指定しますTsgcReportEventSource は、OnFirst、OnNext、OnGetValue を通じてコードから行を取得しますsrcInvoices.SourceName := 'Invoices';
srcInvoices.DataSet := cdsInvoices;
srcLines.SourceName := 'Lines';
srcLines.DataSet := cdsLines;
srcLines.MasterSource := srcInvoices;
srcLines.MasterFields := 'Number';
srcLines.DetailFields := 'Invoice';
sgcEngine.AddDataSource(srcInvoices);
sgcEngine.AddDataSource(srcLines);エンジンはページを一度だけ準備し、すべてのエクスポートが同じ準備済みの結果から出力されるため、どのファイルでも数値は一致します。
出力形式
PDF エクスポートは既定でタグ付き PDF/UA-1 を、長期アーカイブ用には PDF/A-3 を書き出します。XLSX 出力は数値を数値のまま保持するため、後処理なしでスプレッドシートが合計できます。すべてのエクスポートは、ファイルにもストリームにも書き出せます。
FPages := sgcEngine.Prepare;
try
pdfExport.SaveToFile(FPages, OutputFolder + 'orders.pdf');
xlsxExport.SaveToFile(FPages, OutputFolder + 'orders.xlsx');
csvExport.SaveToFile(FPages, OutputFolder + 'orders.csv');
imageExport.SaveToFiles(FPages, OutputFolder + 'orders_%d.png');
finally
FPages.Free;
end;ユーザーは、印刷または保存する前に、PDF と同じ描画でレポートをページ送りして確認できます。
プレビューと印刷
TsgcReportPreviewVCL は、準備されたページをナビゲーション、ズーム、フィットモードとともに表示し、印刷し、PDF に保存します。プレビューでは、一致箇所をハイライトしたテキスト検索、ページのサムネイル表示ができ、Export メニューから PDF、Excel、CSV、PNG、HTML、Word、ODT、ODS、RTF、SVG、プレーンテキストへエクスポートできます。TsgcReportPreviewFMX は、Windows、macOS、iOS、Android で動作する FireMonkey プレビューです。
FirstPage、NextPage、PriorPage、LastPage、ZoomIn、ZoomOut、FitWidth、FitPageprocedure TfrmMain.btnPreviewClick(Sender: TObject);
begin
sgcPreview.Engine := sgcEngine;
sgcPreview.Prepare;
end;
procedure TfrmMain.btnPrintClick(Sender: TObject);
begin
sgcPreview.Print('Sales by region');
end;
KPI ボックス、グラフ、バーコードを備えたシフトレポート。
QR コード付きの取引確認書。
マップと停車地テーブルを備えたルートシート。
夜間の明細書、決済後の請求書、API の背後にあるエクスポートは、ウィンドウのないサーバー上で実行されます。
sgcReports のコアは VCL にも FireMonkey にも依存せず、外部 DLL もプリンタードライバーも不要です。TsgcReportEngine は、Windows サービスや Linux64 デーモンで、ウィンドウなしでレポートを準備します。
各ワーカーは自分のレポート、エンジン、データソース、エクスポートを作成し、読み取り専用の TsgcReportFontManager がすべてのスレッドにサービスを提供します。sgcReportsConfigureForServer は、Windows 上の多数のスレッド向けにメモリマネージャーを調整します。
デザイナーが保存した定義は通常の JSON ファイルなので、サーバーは sgcReportLoadFromJSONFile で読み込み、ヘッドレスで実行できます。ReportLinuxDaemon デモは、ジョブフォルダーを監視し、4 つのワーカースレッドで PDF、XLSX、CSV、PNG を生成します。
sgcReports に移行するアプリケーションには、通常すでに多くのレポートがあります。描き直すのではなく、変換してください。
レポートインポート Registered のみ
TsgcReportImporter は、QuickReport フォーム(TQuickRep を含む .dfm)と ReportBuilder テンプレート(.rtm)を、テキストでもバイナリでも、レポート定義に変換し、対応できなかったオブジェクト、プロパティ、式、スクリプトをすべて一覧にします。VCL、FireMonkey、WinForms、WPF、Avalonia のデザイナーには Import コマンドがあります。一覧を確認し、データソースを追加し、残りをデザイナーで修正して、結果を JSON 定義として保存します。
DataSourceMap がそれを独自のソースに名前変更しますImportResult に直近のインポート結果が保持され、デザイナーは問題点をウィンドウに表示しますoReport := TsgcReport.Create(nil);
oImporter := TsgcReportImporter.Create;
try
// the old pipeline Orders is the data source Sales here
oImporter.DataSourceMap.Values['Orders'] := 'Sales';
try
oImporter.ImportFromFile(oReport, 'orders.rtm');
sgcReportSaveToJSONFile(oReport, 'orders.json');
except
on E: ESgcReportImportError do
WriteLn('Not imported: ', E.Message);
end;
finally
oImporter.Free;
oReport.Free;
end;アプリケーション全体を移行しますか? QuickReport 移行キットが、バンドとコントロールを sgcReports の対応するものに、番号付きの手順で対応づけます。
| ターゲット | 動作する内容 | プラットフォーム |
|---|---|---|
| Delphi 7〜13 | レポートモデル、式、データ、レイアウト、エンジン、流れるようなインターフェースのビルダー、エクスポート | Windows、Linux64、macOS、iOS、Android |
| C++ Builder 2007 から 13 | 同じクラス | 生成された .hpp ヘッダーとスタティックライブラリ |
| VCL デザイナーとプレビュー | TsgcVCLReportDesigner、TsgcReportPreviewVCL | Windows |
| FireMonkey デザイナーとプレビュー | TsgcFMXReportDesigner(Delphi XE6 以降)、TsgcReportPreviewFMX | Windows、macOS、iOS、Android でのプレビュー |
sgcReports は単体で開発者あたり €199 から販売されており、全ソースコードと 1 年間のアップデートが付属し、sgcUI Enterprise と All-Access バンドルにも含まれます。PDF は sgcPDF を通じて書き出され、すべての構成で必須です。エンドユーザー向けデザイナー、レポートインポート、DOCX、ODT、RTF エクスポート、Web デザイナーは Registered エディションに含まれます。体験版ではすべての機能が有効になっています。
TDataSet に TsgcReportDataSetSource でデータをバインドし、TsgcReportBuilder でバンドを記述して、上のコードサンプルのように SaveToPDF を呼び出します。レイアウトを描画したい場合は、フォームに TsgcReport、TsgcReportEngine、TsgcVCLReportDesigner を配置してレポートを設計し、JSON 定義として保存します。どちらの方法でも、同じレポートモデルが生成されます。
はい、Registered エディションで利用できます。TsgcVCLReportDesigner と TsgcFMXReportDesigner は、フォームに埋め込めるエンドユーザー向けデザイナーで、sgcShowReportDesigner はメニューからモーダルで開きます。Web アプリケーションでは、TsgcReportHTMLDesigner がブラウザー内で動作します。すべてのデザイナーは JSON 定義を保存し、sgcReports のどこでも読み込めます。
はい、Registered エディションで可能です。TsgcReportImporter は、ReportBuilder テンプレート(.rtm)をテキストでもバイナリでも、また QuickReport フォーム(TQuickRep を含む .dfm)を、レポート定義に変換し、対応できなかったオブジェクト、プロパティ、式、スクリプトをすべて一覧にします。デザイナーにも同じことを行う Import コマンドがあります。既存のレポートテンプレートを取り込むをご覧ください。
はい。ビルダーの SaveToPDF と SaveToXLSX、または準備済みページに対する TsgcReportPDFExport と TsgcReportXLSXExport が、タグ付き PDF/UA-1(要望に応じて PDF/A-3)と、数値を数値のまま保持する Excel ブックを書き出します。CSV、PNG、HTML、ODS、SVG、プレーンテキストは全エディションに、DOCX、ODT、RTF は Registered エディションに含まれます。
エンジンを TsgcReportPreviewVCL に割り当て、Prepare を呼び出します。プレビューはページ表示、ズーム、テキスト検索、エクスポートを行い、Print は表示中のドキュメントを印刷します。FireMonkey アプリケーションでは、Windows、macOS、iOS、Android で TsgcReportPreviewFMX を使います。
はい。コアは VCL にも FireMonkey にも依存せず、外部 DLL も不要なので、TsgcReportEngine とエクスポートは、スレッドごとに 1 つのエンジンで、Windows サービスや Linux64 デーモンで動作します。ReportLinuxDaemon デモは、フォルダー内のジョブを 4 つのワーカースレッドで描画します。
Delphi 7 から 13、および C++ Builder 2007 から 13 です。TsgcReportBuilder は通常のクラスで、匿名メソッドなしで Delphi 7 でも動作します。FireMonkey デザイナーには Delphi XE6 以降が必要です。同じクラスが .NET でも利用できます。
はい、常に必要です。sgcReports は sgcPDF エンジンで PDF を書き出しバーコードを描画し、プレビューは sgcPDF ビューアーコントロールを通じて描画します。sgcUI Enterprise には両方が含まれます。