A ferramenta de relatórios .NET para C#
O sgcReports é uma ferramenta de relatórios .NET e gerador de relatórios C#: crie relatórios em código, exiba-os em WinForms, WPF e Avalonia e exporte para PDF e Excel.
O sgcReports é uma ferramenta de relatórios .NET e gerador de relatórios C#: crie relatórios em código, exiba-os em WinForms, WPF e Avalonia e exporte para PDF e Excel.
Listas agrupadas, faturas, tabelas e catálogos, preparados uma única vez pelo engine de relatórios e exibidos em uma visualização ou gravados em PDF, Excel, CSV e imagens.
A demonstração ReportTables em .NET WinForms: a visualização com navegação de páginas, zoom, impressão, PDF, busca, miniaturas e exportação, além de botões para o designer e o editor de tabelas.
Um relatório agrupado com um cabeçalho por grupo, subtotais e números de página.
Uma fatura a partir de dados mestre e detalhe, com suas linhas, os totais e um QR code.
Uma definição de relatório em JSON e a página que ela renderiza. Mude um layout sem recompilar o seu aplicativo.
Um relatório preparado, gravado em PDF, uma pasta de trabalho do Excel, um arquivo CSV e um PNG por página.
O editor de tabelas do designer de relatórios: linhas de cabeçalho, dados e rodapé, células mescladas, estilos e destaques.
Forneça os dados ao relatório com um TsgcReportDataTableSource sobre um DataTable, descreva o layout com o TsgcReportBuilder fluente e salve. O builder cria e controla o seu próprio relatório e engine. Todos os tipos estão no namespace esegece.sgcReports, com os mesmos nomes de classe da edição 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;
}
}
Preencha um DataTable a partir do seu banco de dados ou dos seus objetos, entregue-o à fonte de dados e salve o relatório. A saída em PDF é PDF/UA com tags por padrão, e as mesmas páginas preparadas vão para o Excel e o 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");
}
}
O builder também adiciona cabeçalhos e rodapés de página, cabeçalhos de coluna, bandas de detalhe, tabelas, caixas de seleção, códigos de barras, parâmetros de relatório e marcadores. Veja o tópico de ajuda TsgcReportBuilder e o guia de introdução.
Cada pacote de UI tem uma visualização de relatório e um designer de relatórios para o usuário final pronto para uso, para que os seus usuários abram, alterem e salvem layouts de relatório dentro do seu aplicativo. Os designers têm barra de ferramentas, abas Design e Preview, as árvores Toolbox, Outline e Data, um inspetor de propriedades, réguas, desfazer e refazer e um editor de scripts. Os três hosts compartilham um único modelo de designer independente de plataforma.
O pacote esegece.sgcReports.WinForms: o controle de visualização de relatório, TsgcWinFormsReportDesigner (um UserControl), o TsgcWinFormsReportDesignerForm modal e sgcReports_Designer_WinForms.sgcShowReportDesigner.
O pacote esegece.sgcReports.Wpf: TsgcWpfReportPreview com navegação de páginas, zoom, impressão e gravação em PDF, TsgcWpfReportDesigner (um DockPanel) e o TsgcWpfReportDesignerWindow modal.
O pacote esegece.sgcReports.Avalonia: TsgcAvaloniaReportPreview com navegação de páginas, zoom e gravação em PDF, TsgcAvaloniaReportDesigner e sgcShowReportDesignerAsync com seletores de arquivo assíncronos.
As visualizações têm barra de busca, miniaturas de página, o sumário do PDF, um menu Export com onze formatos, um botão Cancel enquanto um relatório longo é preparado e uma solicitação dos parâmetros do relatório. As visualizações estão em todas as edições, as classes de designer estão na edição Registered. Os designers também importam modelos .rtm do ReportBuilder como novos relatórios. Veja a ajuda dos designers .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();
}
}
O sgcReports é um gerador de relatórios C# em bandas: as páginas contêm bandas, as bandas contêm itens, e o engine imprime cada banda na hora certa para os seus dados.
Bandas de título e resumo do relatório, cabeçalho e rodapé de página, cabeçalho de coluna, cabeçalho e rodapé de grupo, dados mestre e dados de detalhe, cada uma com a própria altura, estilo e itens.
Um cabeçalho de grupo inicia um novo grupo a cada vez que a sua expressão muda, e um rodapé de grupo imprime subtotais com funções de agregação como Sum e Count.
Ligue uma fonte de detalhe ao seu mestre com MasterSource, MasterFields e DetailFields, como uma fatura liga as suas linhas à fatura.
Campos e funções entre colchetes dentro de itens de texto, como [Sales.Customer] ou [FormatFloat('#,0.00', Sum(Sales.Amount))], além de destaques que mudam o estilo de um item quando uma condição é verdadeira.
Itens de tabela com linhas de cabeçalho, dados e rodapé, células mescladas e linhas que crescem com o texto, e tabelas de referência cruzada com várias medidas e totais.
Parâmetros de relatório tipados com solicitação, uma pequena linguagem de script guardada no relatório e relatórios que herdam de um layout base, como um papel timbrado.
Os dados vêm de um TsgcReportDataTableSource sobre um DataTable, ou de um TsgcReportJSONSource sobre um array JSON de objetos. Rich text, marcas d'água, códigos de barras, caixas de seleção e marcadores estão em todas as edições. Os itens de gráfico, sparkline, medidor e tabela dinâmica vêm com os pacotes de ponte Registered sgcCharts, sgcGauges e sgcPivotGrid. Veja a matriz de recursos do sgcReports.
O engine prepara as páginas uma única vez, e cada exportação as grava no seu próprio formato. A saída em PDF usa o engine do sgcPDF, então o sgcPDF é necessário em qualquer configuração.
| Formato | Detalhes | .NET Community (gratuita) |
|---|---|---|
| PDF/UA | PDF/UA-1 com tags por padrão, com ordem de leitura, texto alternativo para imagens e títulos marcados. PDF/UA-2 sob demanda. | ✓ |
| PDF/A | PDF/A-3 (rpaA3b, rpaA3a) para arquivos e faturas eletrônicas com o XML da fatura incorporado, e PDF/A-4. | ✓ |
| XLSX e CSV | Pastas de trabalho do Excel e arquivos CSV a partir das mesmas páginas preparadas. | ✓ |
| PNG, SVG, ODS, HTML e texto | Uma imagem por página, planilhas OpenDocument, HTML e texto simples. | ✓ |
| DOCX, ODT e RTF | Documentos do Word, texto OpenDocument e Rich Text Format. | − |
| PDF assinado | O pacote de ponte sgcSign assina as exportações em PDF (PAdES). | ✓ |
O engine e as exportações não precisam de UI, então o mesmo relatório roda em um serviço do Windows, em uma API web ou em um daemon Linux. Carregue uma definição de relatório em JSON salva pelo seu código ou pelo designer, anexe os dados e grave o arquivo.
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 serve relatórios registrados (RegisterReport) como PDF, XLSX, CSV, HTML e outros arquivos, e os pacotes esegece.sgcReports.HTML e esegece.sgcReports.AspNetCore hospedam as suas rotas no ASP.NET Core.
Um servidor prepara relatórios concorrentes com um engine e um conjunto de fontes de dados por thread. As demonstrações .NET incluem os projetos LinuxDaemon e HTTPServer.
esegece.sgcReports contém o builder, as fontes de dados, o engine e as exportações. Adicione o pacote do seu framework de UI para a visualização e o designer, e os pacotes HTML e ASP.NET Core para servir relatórios na 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
Para a edição Community gratuita, use os mesmos ids de pacote com o sufixo .Community, por exemplo dotnet add package esegece.sgcReports.Community. A lista completa de pacotes está na página de download do sgcReports, e a visão geral do .NET explica os componentes. As demonstrações .NET são Invoice, Groups, JSONDefinition, PDFUA, Exports, Fluent, HTTPServer, LinuxDaemon, DatabaseSQL e MobileMAUI.
Os pacotes Community gratuitos incluem o engine, as exportações e as visualizações. A edição Registered adiciona os designers para o usuário final, as exportações DOCX, ODT e RTF e as pontes de gráficos, medidores e tabelas dinâmicas.
| Recurso | .NET Community (gratuita) | Registered |
|---|---|---|
| Builder fluente, modelo de relatório e definições em JSON | ✓ | ✓ |
| Bandas, grupos, mestre-detalhe e expressões | ✓ | ✓ |
| Exportação para PDF/UA e PDF/A-3 | ✓ | ✓ |
| Exportação para XLSX, CSV, PNG, ODS, SVG, HTML e texto simples | ✓ | ✓ |
| Visualizações WinForms, WPF e Avalonia | ✓ | ✓ |
| Engine sem interface gráfica para serviços e Linux | ✓ | ✓ |
| Designer de relatórios para o usuário final em WinForms, WPF e Avalonia | − | ✓ |
| Exportação para DOCX, ODT e RTF | − | ✓ |
| Itens de gráfico, sparkline, medidor e tabela dinâmica | − | ✓ |
Os pacotes .Community são gratuitos para pessoas físicas e organizações com receita bruta anual abaixo de EUR 1M e no máximo 5 desenvolvedores. Organizações que atingem ou superam qualquer um dos limites precisam de uma licença Registered.
Todos os recursos e a licença comercial. Licenças Single, Team e Site, cada uma com código-fonte completo, 1 ano de atualizações e um desconto de renovação de 50% a 70%.
Preços do sgcReports .NET →€199
Licenças Single, Team e Site disponíveis.
Sim. O sgcReports tem uma visualização de relatório e um designer de relatórios para o usuário final para WinForms (esegece.sgcReports.WinForms), WPF (esegece.sgcReports.Wpf) e Avalonia (esegece.sgcReports.Avalonia). As visualizações mostram as páginas com navegação, zoom, busca, miniaturas e exportação. O engine e as exportações estão no pacote principal esegece.sgcReports e funcionam sem nenhuma UI.
Adicione o pacote NuGet esegece.sgcReports (ou esegece.sgcReports.Community), envolva o seu DataTable em um TsgcReportDataTableSource, descreva páginas, bandas e itens com o TsgcReportBuilder fluente e chame SaveToPDF, SaveToXLSX ou SaveToCSV, como no exemplo de criação de relatório. Você também pode carregar o layout de uma definição de relatório em JSON.
Sim, com a edição Registered. TsgcWinFormsReportDesigner, TsgcWpfReportDesigner e TsgcAvaloniaReportDesigner são designers que você coloca na sua própria janela, e sgcShowReportDesigner abre um como janela modal. Os usuários arrastam itens e campos para as bandas, editam propriedades, tabelas e scripts, visualizam o resultado e salvam o layout como uma definição JSON que o seu servidor pode executar sem interface gráfica.
Sim. SaveToPDF grava PDF/UA com tags por padrão, PDFExport.PDFA muda para PDF/A-3, e SaveToXLSX grava uma pasta de trabalho do Excel a partir das mesmas páginas preparadas. CSV, PNG, SVG, ODS, HTML e texto simples estão em todas as edições, e DOCX, ODT e RTF na edição Registered.
Sim. O engine sem interface gráfica e as exportações rodam no Windows e no Linux, em serviços e daemons, e as demonstrações .NET incluem um projeto LinuxDaemon. Para a web, o pacote esegece.sgcReports.AspNetCore integra o endpoint de relatórios ao ASP.NET Core, que serve relatórios como PDF, XLSX, CSV, HTML e outros arquivos.
Sim. Todo pacote NuGet do sgcReports também é distribuído como uma edição Community gratuita com o sufixo .Community, com o engine, as exportações e as visualizações. Ela é gratuita para pessoas físicas e organizações com receita bruta anual abaixo de EUR 1M e no máximo 5 desenvolvedores. Os designers para o usuário final e as exportações DOCX, ODT e RTF exigem uma licença Registered, veja os preços do sgcReports.