面向 .NET 的 C# NuGet 免费的 Community 版本

适用于 C# 的 .NET 报表工具

sgcReports 是 .NET 报表工具和 C# 报表生成器:通过代码构建报表,在 WinForms、WPF 和 Avalonia 中显示,并导出 PDF 和 Excel。

流式 C# 构建器和 JSON 布局 适用于 WinForms、WPF、Avalonia 的设计器 PDF/UA、PDF/A-3、XLSX 和 CSV 可在服务和 Linux 上以无头方式运行

查看价格 →   .NET 下载和演示 →

使用 sgcReports 构建并显示在报表预览中的班次报表:A4 页面,包含 OEE、可用性、性能和质量框,按小时统计的产量图表,按原因统计的停机时间条形图和批次条形码

使用 sgcReports 构建的报表

分组列表、发票、表格和目录,由报表引擎一次准备,可在预览中显示,或写出为 PDF、Excel、CSV 和图像。

如何在 C# 中创建报表

使用基于 DataTable 的 TsgcReportDataTableSource 为报表提供数据,用流式的 TsgcReportBuilder 描述布局,然后保存。构建器会创建并拥有自己的报表和报表引擎。所有类型都在 esegece.sgcReports 命名空间中,类名与 Delphi 版本相同。

SalesReport.cs
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。

Program.cs
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 帮助主题和入门指南。

适用于 WinForms、WPF 和 Avalonia 的报表设计器和查看器

每个 UI 包都带有报表预览和现成的最终用户报表设计器,因此用户可以在你的应用程序内打开、修改和保存报表布局。设计器提供工具栏、Design 和 Preview 选项卡、Toolbox、Outline 和 Data 树、属性检查器、标尺、撤销和重做,以及脚本编辑器。这三种宿主共用同一个与平台无关的设计器模型。

WinForms

esegece.sgcReports.WinForms 包:报表预览控件、TsgcWinFormsReportDesigner(一个 UserControl)、模态的 TsgcWinFormsReportDesignerForm 和 sgcReports_Designer_WinForms.sgcShowReportDesigner。

WPF

esegece.sgcReports.Wpf 包:支持页面导航、缩放、打印和 PDF 保存的 TsgcWpfReportPreview、TsgcWpfReportDesigner(一个 DockPanel)和模态的 TsgcWpfReportDesignerWindow。

Avalonia

esegece.sgcReports.Avalonia 包:支持页面导航、缩放和 PDF 保存的 TsgcAvaloniaReportPreview、TsgcAvaloniaReportDesigner,以及带异步文件选择器的 sgcShowReportDesignerAsync。

预览带有查找栏、页面缩略图、PDF 大纲、支持十一种格式的导出菜单、准备长报表时的取消按钮,以及报表参数提示。预览在所有版本中都有,设计器类属于 Registered 版本。设计器还可将 ReportBuilder 的 .rtm 模板导入为新报表。请参阅 .NET 设计器帮助。

SalesForm.cs
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();
    }
}
DesignerWindow.cs
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 功能对比表。

在 C# 中将报表导出为 PDF 和 Excel

引擎只准备一次页面,每种导出以各自的格式写出这些页面。PDF 输出使用 sgcPDF 引擎,因此在所有配置中都需要 sgcPDF。

格式详情.NET Community(免费)
PDF/UA默认为带标签的 PDF/UA-1,包含阅读顺序、图像替代文字和标记的标题。按需提供 PDF/UA-2。✓
PDF/APDF/A-3(rpaA3b、rpaA3a)用于存档和嵌入发票 XML 的电子发票,另有 PDF/A-4。✓
XLSX 和 CSV由同一组已准备好的页面生成 Excel 工作簿和 CSV 文件。✓
PNG、SVG、ODS、HTML 和文本每页一张图像、OpenDocument 电子表格、HTML 和纯文本。✓
DOCX、ODT 和 RTFWord 文档、OpenDocument 文本和 Rich Text Format。−
已签名的 PDFsgcSign 桥接包可对导出的 PDF 进行签名(PAdES)。✓

在服务、ASP.NET Core 和 Linux 上生成报表

引擎和导出都不需要 UI,因此同一份报表可在 Windows 服务、Web API 或 Linux 守护进程中运行。加载由你的代码或设计器保存的 JSON 报表定义,附加数据并写出文件。

ReportJob.cs
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);
        }
    }
}

通过 HTTP 提供报表

TsgcReportHTTPEndpoint 可将已注册的报表(RegisterReport)以 PDF、XLSX、CSV、HTML 等文件形式提供,esegece.sgcReports.HTML 和 esegece.sgcReports.AspNetCore 包则在 ASP.NET Core 中托管其路由。

每个线程一个引擎

服务器使用每个线程一个引擎和一组数据源来并发准备报表。.NET 演示包含 LinuxDaemon 和 HTTPServer 项目。

从 NuGet 安装 .NET 报表工具

esegece.sgcReports 包含构建器、数据源、引擎和导出。添加你所用 UI 框架的包以获得预览和设计器,并添加 HTML 和 ASP.NET Core 包以通过 Web 提供报表。

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 版本

免费的 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,免费

.Community 包对年总收入低于 100 万欧元且开发者不超过 5 人的个人和组织免费。达到或超过任一门槛的组织需要 Registered 许可证。

NuGet 上的 esegece.sgcReports.Community →

Registered

包含所有功能和商业许可证。提供 Single、Team 和 Site 许可证,均含完整源代码、1 年更新以及 50% 到 70% 的续订折扣。

sgcReports .NET 价格 →

sgcReports .NET

€199

提供 Single、Team 和 Site 许可证。

  • 引擎、导出以及 WinForms、WPF 和 Avalonia 包
  • HTML 和 ASP.NET Core 包
  • 完整源代码
  • 1 年更新

.NET 报表常见问题

有。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 价格。

超值之选:All-AccesseSeGeCe 全部产品,含高级支持,每年 €1,059 起。
查看 All-Access 价格

为你的 .NET 应用程序添加报表

使用一个 NuGet 包,即可用 C# 构建报表,在 WinForms、WPF 和 Avalonia 中显示,并导出 PDF 和 Excel。