Report Builder für Delphi: Berichte visuell oder per Code entwerfen
sgcReports ist ein Report Builder für Delphi und C++ Builder: Deine Benutzer entwerfen Berichte visuell, und dein Code baut sie mit der Fluent-Klasse TsgcReportBuilder.
sgcReports ist ein Report Builder für Delphi und C++ Builder: Deine Benutzer entwerfen Berichte visuell, und dein Code baut sie mit der Fluent-Klasse TsgcReportBuilder.
Ein Bericht ist ein Modell aus Seiten, Bändern, Elementen, Stilen und Datenquellen. Der Designer und der Code bearbeiten beide dieses Modell, und eine JSON-Definition speichert es.
Deine Benutzer entwerfen Berichte visuell im VCL-, FireMonkey- oder Web-Berichtsdesigner, und dein Code baut sie mit der Fluent-Klasse TsgcReportBuilder. Beide erzeugen dasselbe Berichtsmodell mit Bändern, Gruppen, Master-Detail und Ausdrücken, das du in der Vorschau ansehen, drucken oder nach PDF, Excel, CSV und mehr exportieren kannst, auf dem Desktop oder in einem Dienst ohne Fenster.
Platziere einen TsgcVCLReportDesigner oder einen TsgcFMXReportDesigner auf einem Formular oder liefere TsgcReportHTMLDesigner im Browser aus. Benutzer ziehen Felder auf Bänder, setzen Eigenschaften in einem Inspektor und wechseln zu einer Live-Vorschau. Registered
TsgcReportBuilder beschreibt Stile, Seiten, Bänder und Elemente als eine einzige Fluent-Kette. Der Bericht lässt sich zusammen mit dem Rest deines Projekts kompilieren, vergleichen und umbauen und funktioniert ab Delphi 7, ganz ohne anonyme Methoden.
Speichere einen Bericht mit sgcReportSaveToJSONFile und lade ihn zur Laufzeit, sodass ein Layout in einer Datenbank oder einem Kundenordner liegen und sich ohne neuen Build ändern kann. Die Designer öffnen und speichern dieselben Dateien.
Ein Berichtsdesigner für Endbenutzer, den deine Benutzer in deiner Anwendung ausführen, und derselbe Designer zur Entwurfszeit in der IDE.
Berichtsdesigner Nur Registered
TsgcVCLReportDesigner ist ein Panel mit Symbolleiste, den Registern Toolbox, Outline und Data, einer Entwurfsfläche mit Linealen, einem Eigenschaftsinspektor sowie den Registern Design und Preview. Platziere es auf einem Formular, weise Engine zu, füge die Datenquellen hinzu, und deine Benutzer bearbeiten den Bericht, speichern ihn als JSON-Definition und sehen ihn mit Live-Daten in der Vorschau. TsgcFMXReportDesigner ist der FireMonkey-Zwilling, gebaut auf denselben Designer-Units.
TsgcReportEngine und wähle Design report…, um ihren Bericht mit demselben Designer zu bearbeitenVerbinde den Designer beim Erstellen des Formulars mit der Engine und den Datenquellen und lade das zuletzt gespeicherte Layout:
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;Um einen Bericht über ein Menü ohne eigenes Formular zu bearbeiten, zeigt sgcShowReportDesigner (VCL) oder sgcShowReportDesignerFMX (FireMonkey, Windows und macOS) den Designer modal mit den Schaltflächen OK und Cancel und stellt den Bericht wieder her, wenn der Benutzer abbricht:
procedure TfrmMain.mnuEditReportClick(Sender: TObject);
begin
if sgcShowReportDesigner(sgcEngine) then
sgcReportSaveToJSONFile(sgcEngine.Report, 'orders.json');
end;TsgcFMXReportDesigner (Delphi XE6 und höher) hat dieselbe Symbolleiste, dieselben Bäume, dieselbe Fläche, denselben Inspektor und dasselbe Preview-Register und hostet eine TsgcReportPreviewFMX. ToolbarButtonSize macht die Schaltflächen auf einem Touchscreen leicht antippbar. Das modale Formular und die Dateidialoge sind unter Windows und macOS verfügbar.
TsgcReportHTMLDesigner bearbeitet die JSON-Definition im Browser mit einer Band-Canvas, einem Eigenschaftsinspektor und einer Live-Vorschau, ausgeliefert vom selben HTTP-Endpunkt wie der fertige Bericht. Er braucht sgcWebSockets Professional oder höher und sgcHTML. Lass DesignerEnabled auf produktiven Endpunkten deaktiviert und stelle ihn hinter deine eigene Authentifizierung.
sgcReports für .NET enthält Endbenutzer-Designer für WinForms, WPF und Avalonia, die Gegenstücke zu TsgcVCLReportDesigner, mit derselben Symbolleiste, denselben Bäumen, demselben Inspektor und derselben Vorschau. Sie laden und speichern ebenfalls JSON-Definitionen.
Ein gruppierter Umsatzbericht über ein beliebiges TDataSet: ein Header pro Region, eine Zeile pro Verkauf, eine Zwischensumme pro Region und eine Seitenfußzeile, gespeichert als PDF und 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 und PageFooter lesen sich wie das Layout, das sie erzeugenSaveToPDF, SaveToXLSX, SaveToCSV und SaveToPNG bereiten direkt aus dem Builder auf und exportieren, und Stream-Varianten wie SaveToPDFStream bedienen Web-AntwortenTsgcReport-Modell, das als Report verfügbar ist, und seine Engine verbindet sich mit einer VorschauEin echtes bandbasiertes Layout, sodass Geschäftsberichte wie Umsatz nach Region oder Rechnungen nach Kunde ohne Umwege auskommen.
Bänder und Gruppen
Ein Bericht hat die Bänder Berichtstitel, Seitenkopf, Gruppenkopf, Daten, Gruppenfuß, Seitenfuß und Zusammenfassung sowie Spaltenköpfe und -füße. Eine Gruppe wechselt, wenn sich ihr Ausdruck ändert, druckt ihre eigenen Summen und kann eine neue Seite beginnen oder ihren Header auf jeder Seite wiederholen. Unterberichte lassen eine Seite das Layout einer anderen einbinden.
GroupExpression an einem Gruppenkopfband sowie verschachtelte Gruppen für zwei oder mehr EbenenStartNewPage, RepeatOnEveryPage und KeepTogether steuern den SeitenflussPrintOnFirstPage und PrintOnLastPage legen fest, wo Seitenbänder erscheinenAusdrücke
Jedes Textelement enthält Ausdrücke in eckigen Klammern, die die Engine für jede Zeile auswertet, sodass eine Fußzeilensumme immer zu den darüber gedruckten Zeilen passt. Es gibt 68 Funktionen und 10 Aggregate, darunter Datumsarithmetik, Auffüllen und Formatieren, ToWords in 12 Sprachen, bedingte Aggregate und laufende Werte, die mit jeder Gruppe neu beginnen.
'[Sum(Lines.Qty * Lines.Price)]'
'[FormatDateTime(''dd/mm/yyyy'', Invoices.Date)]'
'Page [Page] of [TotalPages]'Sum, FormatFloat, FormatDateTime, Upper, Round, IsNull, SumIf, CountIf, RunningSum und PreviousOnGetVariable liefert deine eigenen Variablen zur LaufzeitHighlights wenden einen Stil an, wenn eine Bedingung zutrifft, zum Beispiel negative Beträge in Rot, ganz ohne SkriptDer Bericht liest deine Daten dort, wo sie schon liegen: in einer Abfrage, einem JSON-Dokument oder deinen eigenen Objekten.
Master-Detail
TsgcReportDataSetSource liest jedes TDataSet, etwa TClientDataSet, FireDAC oder dbExpress. Eine Detailquelle ist über Schlüsselfelder mit ihrem Master verknüpft, sodass jede Rechnung ihre eigenen Zeilen druckt und die Gruppenfußzeile sie summiert. Ein ungeöffnetes Dataset wird für den Lauf geöffnet und danach wieder geschlossen; ein bereits geöffnetes erhält danach seinen Zustand und seine Position zurück.
MasterSource, MasterFields und DetailFields verknüpfen die QuellenTsgcReportJSONSource liest einen JSON-String oder eine JSON-Datei, RecordsPath wählt das ArrayTsgcReportEventSource holt Zeilen über OnFirst, OnNext und OnGetValue aus deinem CodesrcInvoices.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);Die Engine bereitet die Seiten einmal auf, und jeder Export arbeitet mit demselben aufbereiteten Ergebnis, sodass die Zahlen in jeder Datei identisch sind.
Ausgabeformate
Der PDF-Export schreibt standardmäßig getaggtes PDF/UA-1 und PDF/A-3 für Langzeitarchive. Die XLSX-Ausgabe behält Zahlen als Zahlen, sodass die Tabelle sie ohne Nachbearbeitung summiert. Jeder Export kann in eine Datei oder einen Stream schreiben.
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;Benutzer blättern durch den Bericht, bevor sie ihn drucken oder speichern, mit derselben Darstellung wie im PDF.
Vorschau und Druck
TsgcReportPreviewVCL zeigt die aufbereiteten Seiten mit Navigation, Zoom und Anpassungsmodi, druckt sie und speichert sie als PDF. Die Vorschauen suchen Text mit hervorgehobenen Treffern, zeigen Seitenminiaturen und exportieren über ein Export-Menü nach PDF, Excel, CSV, PNG, HTML, Word, ODT, ODS, RTF, SVG und Klartext. TsgcReportPreviewFMX ist die FireMonkey-Vorschau unter Windows, macOS, iOS und Android.
FirstPage, NextPage, PriorPage und LastPage, ZoomIn, ZoomOut, FitWidth und FitPageprocedure TfrmMain.btnPreviewClick(Sender: TObject);
begin
sgcPreview.Engine := sgcEngine;
sgcPreview.Prepare;
end;
procedure TfrmMain.btnPrintClick(Sender: TObject);
begin
sgcPreview.Print('Sales by region');
end;
Ein Schichtbericht mit KPI-Boxen, einem Diagramm und einem Barcode.
Eine Handelsbestätigung mit QR-Code.
Ein Routenblatt mit Karte und Haltestellentabelle.
Nächtliche Kontoauszüge, Rechnungen nach dem Checkout und Exporte hinter einer API laufen auf einem Server ohne Fenster.
Der Kern von sgcReports hat keine Abhängigkeit von VCL oder FireMonkey und braucht weder eine externe DLL noch einen Druckertreiber. TsgcReportEngine bereitet Berichte ohne Fenster auf, in einem Windows-Dienst oder einem Linux64-Daemon.
Jeder Worker erstellt seinen eigenen Bericht, seine eigene Engine, eigene Datenquellen und Exporte, während ein schreibgeschützter TsgcReportFontManager jeden Thread bedient. sgcReportsConfigureForServer stimmt den Speichermanager unter Windows auf viele Threads ab.
Eine vom Designer gespeicherte Definition ist eine normale JSON-Datei, sodass ein Server sie mit sgcReportLoadFromJSONFile lädt und headless ausführt. Die Demo ReportLinuxDaemon überwacht einen Jobs-Ordner und rendert PDF, XLSX, CSV oder PNG mit 4 Worker-Threads.
Eine Anwendung, die auf sgcReports umsteigt, hat meist schon viele Berichte. Konvertiere sie, statt sie neu zu zeichnen.
Berichtsimport Nur Registered
TsgcReportImporter konvertiert QuickReport-Formulare (.dfm mit einem TQuickRep) und ReportBuilder-Vorlagen (.rtm), als Text oder binär, in Berichtsdefinitionen und listet jedes Objekt, jede Eigenschaft, jeden Ausdruck und jedes Skript auf, die er nicht zuordnen konnte. Die Designer für VCL, FireMonkey, WinForms, WPF und Avalonia haben einen Befehl Import. Du prüfst die Liste, fügst die Datenquellen hinzu, korrigierst den Rest im Designer und speicherst das Ergebnis als JSON-Definition.
DataSourceMap benennt ihn in deine eigene Quelle umImportResult enthält das Ergebnis des letzten Imports, und die Designer zeigen die Probleme in einem FensteroReport := 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;Du portierst eine ganze Anwendung? Das QuickReport-Migrationskit ordnet Bänder und Controls ihren sgcReports-Gegenstücken zu, mit nummerierten Schritten.
| Ziel | Was läuft | Plattformen |
|---|---|---|
| Delphi 7 bis 13 | Berichtsmodell, Ausdrücke, Daten, Layout, Engine, Fluent-Builder und Exporte | Windows, Linux64, macOS, iOS und Android |
| C++ Builder 2007 bis 13 | Dieselben Klassen | Generierte .hpp-Header und statische Bibliotheken |
| VCL-Designer und -Vorschau | TsgcVCLReportDesigner, TsgcReportPreviewVCL | Windows |
| FireMonkey-Designer und -Vorschau | TsgcFMXReportDesigner (Delphi XE6 und höher), TsgcReportPreviewFMX | Vorschau unter Windows, macOS, iOS und Android |
sgcReports wird einzeln ab €199 pro Entwickler verkauft, mit vollständigem Quellcode und 1 Jahr Updates, und ist in sgcUI Enterprise und im All-Access-Paket enthalten. Es schreibt PDF über sgcPDF, das in jeder Konfiguration erforderlich ist. Die Endbenutzer-Designer, der Berichtsimport, der DOCX-, ODT- und RTF-Export und der Web-Designer gehören zur Registered-Edition; die Testversion hat jede Funktion freigeschaltet.
Binde deine Daten mit einer TsgcReportDataSetSource über einem TDataSet, beschreibe die Bänder mit TsgcReportBuilder und rufe SaveToPDF auf, wie im Codebeispiel oben. Wenn du das Layout lieber zeichnest, platziere ein TsgcReport, eine TsgcReportEngine und einen TsgcVCLReportDesigner auf einem Formular, entwirf den Bericht und speichere ihn als JSON-Definition. Beide Wege erzeugen dasselbe Berichtsmodell.
Ja, in der Registered-Edition. TsgcVCLReportDesigner und TsgcFMXReportDesigner sind Endbenutzer-Designer, die du in deine Formulare einbettest, und sgcShowReportDesigner öffnet einen modal aus einem Menü. Für Webanwendungen läuft TsgcReportHTMLDesigner im Browser. Jeder Designer speichert JSON-Definitionen, die sich überall in sgcReports laden lassen.
Ja, in der Registered-Edition. TsgcReportImporter konvertiert ReportBuilder-Vorlagen (.rtm), als Text oder binär, und QuickReport-Formulare (.dfm mit einem TQuickRep) in Berichtsdefinitionen und listet jedes Objekt, jede Eigenschaft, jeden Ausdruck und jedes Skript auf, die er nicht zuordnen konnte. Die Designer haben einen Befehl Import, der dasselbe tut. Siehe Bring deine vorhandenen Berichtsvorlagen mit.
Ja. SaveToPDF und SaveToXLSX am Builder oder TsgcReportPDFExport und TsgcReportXLSXExport auf aufbereiteten Seiten schreiben getaggtes PDF/UA-1 (PDF/A-3 auf Wunsch) und Excel-Arbeitsmappen, die Zahlen als Zahlen behalten. CSV, PNG, HTML, ODS, SVG und Klartext sind in jeder Edition enthalten, DOCX, ODT und RTF in der Registered-Edition.
Weise die Engine einer TsgcReportPreviewVCL zu und rufe Prepare auf. Die Vorschau blättert, zoomt, sucht Text und exportiert, und Print druckt das angezeigte Dokument. FireMonkey-Anwendungen verwenden TsgcReportPreviewFMX unter Windows, macOS, iOS und Android.
Ja. Der Kern hat keine Abhängigkeit von VCL oder FireMonkey und keine externe DLL, sodass TsgcReportEngine und die Exports in Windows-Diensten und Linux64-Daemons laufen, mit einer Engine pro Thread. Die Demo ReportLinuxDaemon rendert Jobs aus einem Ordner mit 4 Worker-Threads.
Delphi 7 bis 13 und C++ Builder 2007 bis 13. TsgcReportBuilder ist eine einfache Klasse, die unter Delphi 7 funktioniert, ganz ohne anonyme Methoden. Der FireMonkey-Designer braucht Delphi XE6 oder höher. Dieselben Klassen gibt es für .NET.
Ja, immer. sgcReports schreibt PDF und zeichnet Barcodes mit der sgcPDF-Engine, und die Vorschauen zeichnen über das sgcPDF-Viewer-Control. sgcUI Enterprise enthält beides.