Delphi 报表生成器:可视化或通过代码设计报表
sgcReports 是适用于 Delphi 和 C++ Builder 的报表生成器:用户可以可视化地设计报表,你的代码则可以使用流式的 TsgcReportBuilder 类来构建报表。
sgcReports 是适用于 Delphi 和 C++ Builder 的报表生成器:用户可以可视化地设计报表,你的代码则可以使用流式的 TsgcReportBuilder 类来构建报表。
报表是由页面、分带、项目、样式和数据源组成的模型。设计器和代码都编辑这个模型,并以 JSON 定义保存它。
用户可在 VCL、FireMonkey 或 Web 报表设计器中可视化地设计报表,你的代码则使用流式的 TsgcReportBuilder 类构建报表。两者生成的是同一个报表模型,包含分带、分组、主从明细和表达式,你可以在桌面或无窗口的服务中预览、打印或导出为 PDF、Excel、CSV 等格式。
在窗体上放置 TsgcVCLReportDesigner 或 TsgcFMXReportDesigner,或在浏览器中提供 TsgcReportHTMLDesigner。用户可将字段拖到分带上,在检查器中设置属性,并切换到实时预览。Registered
TsgcReportBuilder 以一条流式调用链描述样式、页面、分带和项目。报表可以和项目的其余部分一起编译、比较差异和重构,从 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 连接到预览真正的分带布局,因此按地区统计销售或按客户汇总发票等业务报表无需任何变通办法。
分带与分组
报表包含报表标题、页头、分组头、数据、分组脚、页脚和汇总分带,以及列头和列脚。当分组表达式变化时,分组会中断并打印自己的合计,还可以另起一页,或在每一页重复其表头。子报表可让一个页面包含另一个页面的布局。
GroupExpression,以及用于两级或更多级的嵌套分组StartNewPage、RepeatOnEveryPage 和 KeepTogether 控制页面流PrintOnFirstPage 和 PrintOnLastPage 决定页面分带的出现位置表达式
任何文本项目都可以包含放在方括号中的表达式,由引擎对每一行求值,因此页脚合计始终与上方打印的各行一致。共有 68 个函数和 10 个聚合函数,包括日期运算、填充和格式化、支持 12 种语言的 ToWords、条件聚合,以及在每个分组重新开始的累计值。
'[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 可读取任意 TDataSet,例如 TClientDataSet、FireDAC 或 dbExpress。明细数据源通过键字段链接到其主数据源,因此每张发票会打印自己的明细行,分组脚则对它们求和。数据集未打开时,会在运行前后打开和关闭;已经打开时,运行结束后会恢复其状态和位置。
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。预览可查找文本并高亮匹配项,显示页面缩略图,并通过导出菜单导出为 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 框、图表和条形码的班次报表。
带二维码的交易确认单。
带地图和停靠点表格的路线单。
夜间对账单、结账后的发票以及 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 设计器都有导入命令。你检查该列表,添加数据源,在设计器中修正其余部分,并将结果保存为 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 套装中。它通过 sgcPDF 写出 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)转换为报表定义,并列出所有无法映射的对象、属性、表达式和脚本。设计器中的导入命令也能完成同样的操作。请参阅沿用你现有的报表模板。
可以。使用构建器上的 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 和各种导出可在 Windows 服务和 Linux64 守护进程中运行,每个线程一个引擎。ReportLinuxDaemon 演示使用 4 个工作线程渲染文件夹中的作业。
Delphi 7 到 13 以及 C++ Builder 2007 到 13。TsgcReportBuilder 是一个普通的类,可在 Delphi 7 上使用,无需匿名方法。FireMonkey 设计器需要 Delphi XE6 或更高版本。.NET 也提供相同的类。
需要,始终需要。sgcReports 使用 sgcPDF 引擎写出 PDF 并绘制条形码,预览则通过 sgcPDF 查看器控件绘制。sgcUI Enterprise 同时包含两者。