Report Builder voor Delphi: ontwerp rapporten visueel of in code
sgcReports is een report builder voor Delphi en C++ Builder: je gebruikers ontwerpen rapporten visueel, en je code bouwt ze met de fluent klasse TsgcReportBuilder.
sgcReports is een report builder voor Delphi en C++ Builder: je gebruikers ontwerpen rapporten visueel, en je code bouwt ze met de fluent klasse TsgcReportBuilder.
Een rapport is een model van pagina's, banden, items, stijlen en gegevensbronnen. De ontwerper en de code bewerken beide dat model, en een JSON-definitie slaat het op.
Je gebruikers ontwerpen rapporten visueel in de VCL-, FireMonkey- of webrapportontwerper, en je code bouwt ze met de fluent klasse TsgcReportBuilder. Beide leveren hetzelfde rapportmodel op, met banden, groepen, master-detail en expressies, dat je bekijkt, afdrukt of exporteert naar PDF, Excel, CSV en meer, op het bureaublad of in een service zonder venster.
Plaats een TsgcVCLReportDesigner of een TsgcFMXReportDesigner op een formulier, of serveer TsgcReportHTMLDesigner in de browser. Gebruikers slepen velden naar banden, stellen eigenschappen in een inspector in en schakelen over naar een live voorbeeld. Registered
TsgcReportBuilder beschrijft stijlen, pagina's, banden en items als één fluent keten. Het rapport compileert, vergelijkt en refactort mee met de rest van je project, en werkt vanaf Delphi 7, zonder dat anonieme methoden nodig zijn.
Sla een rapport op met sgcReportSaveToJSONFile en laad het tijdens runtime, zodat een indeling in een database of een klantmap kan staan en kan veranderen zonder nieuwe build. De ontwerpers openen en bewaren dezelfde bestanden.
Een rapportontwerper voor eindgebruikers die je gebruikers binnen je toepassing uitvoeren, en dezelfde ontwerper tijdens het ontwerpen in de IDE.
Rapportontwerper Alleen Registered
TsgcVCLReportDesigner is een paneel met een werkbalk, de tabbladen Toolbox, Outline en Data, een ontwerpvlak met linialen, een eigenschappeninspector en de tabbladen Design en Preview. Plaats het op een formulier, wijs Engine toe, voeg de gegevensbronnen toe, en je gebruikers bewerken het rapport, slaan het op als JSON-definitie en bekijken het met live gegevens. TsgcFMXReportDesigner is de FireMonkey-tegenhanger, gebouwd op dezelfde ontwerperunits.
TsgcReportEngine in de IDE en kies Design report… om het rapport met dezelfde ontwerper te bewerkenVerbind de ontwerper met de engine en de gegevensbronnen wanneer het formulier wordt aangemaakt, en laad de laatst opgeslagen indeling:
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;Om een rapport vanuit een menu te bewerken zonder eigen formulier toont sgcShowReportDesigner (VCL) of sgcShowReportDesignerFMX (FireMonkey, Windows en macOS) de ontwerper modaal met knoppen OK en Cancel, en herstelt het rapport wanneer de gebruiker annuleert:
procedure TfrmMain.mnuEditReportClick(Sender: TObject);
begin
if sgcShowReportDesigner(sgcEngine) then
sgcReportSaveToJSONFile(sgcEngine.Report, 'orders.json');
end;TsgcFMXReportDesigner (Delphi XE6 en later) heeft dezelfde werkbalk, bomen, ontwerpvlak, inspector en previewtabblad, en bevat een TsgcReportPreviewFMX. ToolbarButtonSize maakt de knoppen makkelijk aan te tikken op een touchscreen. Het modale formulier en de bestandsdialogen zijn beschikbaar op Windows en macOS.
TsgcReportHTMLDesigner bewerkt de JSON-definitie in de browser met een bandcanvas, een eigenschappeninspector en een live voorbeeld, geserveerd door hetzelfde HTTP-eindpunt als het afgeronde rapport. Het vereist sgcWebSockets Professional of hoger en sgcHTML. Laat DesignerEnabled uit op productie-eindpunten en plaats het achter je eigen authenticatie.
sgcReports voor .NET bevat ontwerpers voor eindgebruikers voor WinForms, WPF en Avalonia, de tegenhangers van TsgcVCLReportDesigner, met dezelfde werkbalk, bomen, inspector en voorbeeld. Ze laden en bewaren ook JSON-definities.
Een gegroepeerd verkooprapport over een willekeurige TDataSet: een kop per regio, een regel per verkoop, een subtotaal per regio en een paginavoettekst, opgeslagen als PDF en 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 en PageFooter lezen als de indeling die ze opleverenSaveToPDF, SaveToXLSX, SaveToCSV en SaveToPNG bereiden voor en exporteren rechtstreeks vanuit de builder, en streamvarianten zoals SaveToPDFStream bedienen webresponsesTsgcReport-model, beschikbaar als Report, en zijn Engine koppelt aan een voorbeeldEen echte bandindeling, zodat zakelijke rapporten zoals verkoop per regio of facturen per klant geen omwegen nodig hebben.
Banden en groepen
Een rapport heeft banden voor rapporttitel, paginakop, groepskop, gegevens, groepsvoettekst, paginavoettekst en samenvatting, plus kolomkoppen en kolomvoetteksten. Een groep breekt wanneer zijn expressie verandert, drukt zijn eigen totalen af en kan een nieuwe pagina beginnen of zijn kop op elke pagina herhalen. Met subrapporten kan één pagina de indeling van een andere bevatten.
GroupExpression op een groepskopband, en geneste groepen voor twee of meer niveausStartNewPage, RepeatOnEveryPage en KeepTogether sturen de paginastroomPrintOnFirstPage en PrintOnLastPage bepalen waar paginabanden verschijnenExpressies
Elk tekstitem bevat expressies tussen haakjes, die de engine voor elke rij evalueert, zodat een totaal in de voettekst altijd overeenkomt met de regels die erboven zijn afgedrukt. Er zijn 68 functies en 10 aggregaties, waaronder datumberekeningen, opvullen en opmaken, ToWords in 12 talen, voorwaardelijke aggregaties en lopende waarden die bij elke groep opnieuw 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 en PreviousOnGetVariable levert je eigen variabelen tijdens runtimeHighlights passen een stijl toe wanneer een voorwaarde waar is, bijvoorbeeld negatieve bedragen in rood, zonder scriptHet rapport leest je gegevens waar ze al staan: een query, een JSON-document of je eigen objecten.
Master-detail
TsgcReportDataSetSource leest elke TDataSet, zoals TClientDataSet, FireDAC of dbExpress. Een detailbron koppelt aan zijn master via sleutelvelden, zodat elke factuur zijn eigen regels afdrukt en de groepsvoettekst ze optelt. Een gesloten dataset wordt rond de run geopend en gesloten; een al geopende dataset krijgt daarna zijn status en positie terug.
MasterSource, MasterFields en DetailFields koppelen de bronnenTsgcReportJSONSource leest een JSON-tekenreeks of -bestand, RecordsPath kiest de arrayTsgcReportEventSource haalt rijen uit je code via OnFirst, OnNext en OnGetValuesrcInvoices.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);De engine bereidt de pagina's één keer voor en elke export werkt vanuit hetzelfde voorbereide resultaat, zodat de cijfers in elk bestand identiek zijn.
Uitvoerformaten
De PDF-export schrijft standaard getagde PDF/UA-1, en PDF/A-3 voor langetermijnarchieven. XLSX-uitvoer behoudt getallen als getallen, zodat het werkblad ze zonder opschonen optelt. Elke export kan naar een bestand of naar een stream schrijven.
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;Gebruikers bladeren door het rapport voordat ze het afdrukken of opslaan, met dezelfde weergave als de PDF.
Voorbeeld en afdrukken
TsgcReportPreviewVCL toont de voorbereide pagina's met navigatie, zoom- en passtanden, drukt ze af en slaat ze op als PDF. De voorbeelden zoeken tekst met gemarkeerde treffers, tonen paginaminiaturen en exporteren vanuit een menu Export naar PDF, Excel, CSV, PNG, HTML, Word, ODT, ODS, RTF, SVG en platte tekst. TsgcReportPreviewFMX is het FireMonkey-voorbeeld op Windows, macOS, iOS en Android.
FirstPage, NextPage, PriorPage en LastPage, ZoomIn, ZoomOut, FitWidth en FitPageprocedure TfrmMain.btnPreviewClick(Sender: TObject);
begin
sgcPreview.Engine := sgcEngine;
sgcPreview.Prepare;
end;
procedure TfrmMain.btnPrintClick(Sender: TObject);
begin
sgcPreview.Print('Sales by region');
end;
Een ploegenrapport met KPI-vakken, een diagram en een barcode.
Een handelsbevestiging met een QR-code.
Een routeblad met een kaart en een haltetabel.
Nachtelijke afschriften, facturen na het afrekenen en exports achter een API draaien op een server zonder venster.
De sgcReports-kern heeft geen VCL- of FireMonkey-afhankelijkheid en heeft geen externe DLL of printerstuurprogramma nodig. TsgcReportEngine bereidt rapporten voor zonder venster, in een Windows-service of een Linux64-daemon.
Elke worker maakt zijn eigen rapport, engine, gegevensbronnen en exports aan, terwijl een alleen-lezen TsgcReportFontManager elke thread bedient. sgcReportsConfigureForServer stemt de geheugenmanager af op veel threads op Windows.
Een definitie die door de ontwerper is opgeslagen is een gewoon JSON-bestand, dus een server laadt het met sgcReportLoadFromJSONFile en voert het headless uit. De demo ReportLinuxDaemon bewaakt een taakmap en maakt PDF, XLSX, CSV of PNG met 4 worker-threads.
Een toepassing die naar sgcReports overstapt heeft meestal al veel rapporten. Converteer ze in plaats van ze opnieuw te tekenen.
Rapportimport Alleen Registered
TsgcReportImporter converteert QuickReport-formulieren (.dfm met een TQuickRep) en ReportBuilder-sjablonen (.rtm), als tekst of binair, naar rapportdefinities en toont elk object, elke eigenschap, expressie en elk script dat hij niet kon koppelen. De ontwerpers voor VCL, FireMonkey, WinForms, WPF en Avalonia hebben een opdracht Import. Je controleert de lijst, voegt de gegevensbronnen toe, herstelt de rest in de ontwerper en slaat het resultaat op als JSON-definitie.
DataSourceMap hernoemt hem naar je eigen bronImportResult bevat het resultaat van de laatste import, en de ontwerpers tonen de problemen in een vensteroReport := 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;Een hele toepassing verhuizen? De QuickReport-migratiekit koppelt banden en besturingselementen aan hun sgcReports-tegenhangers met genummerde stappen.
| Doel | Wat er draait | Platforms |
|---|---|---|
| Delphi 7 tot 13 | Rapportmodel, expressies, gegevens, indeling, engine, fluent builder en exports | Windows, Linux64, macOS, iOS en Android |
| C++ Builder 2007 tot 13 | Dezelfde klassen | Gegenereerde .hpp-headers en statische bibliotheken |
| VCL-ontwerper en voorbeeld | TsgcVCLReportDesigner, TsgcReportPreviewVCL | Windows |
| FireMonkey-ontwerper en voorbeeld | TsgcFMXReportDesigner (Delphi XE6 en later), TsgcReportPreviewFMX | Voorbeeld op Windows, macOS, iOS en Android |
sgcReports wordt los verkocht vanaf €199 per ontwikkelaar, met volledige broncode en 1 jaar updates, en zit in sgcUI Enterprise en de All-Access-bundel. Het schrijft PDF via sgcPDF, dat in elke configuratie vereist is. De ontwerpers voor eindgebruikers, de rapportimport, de export naar DOCX, ODT en RTF en de webontwerper zitten in de Registered-editie; de proefversie heeft elke functie ontgrendeld.
Bind je gegevens met een TsgcReportDataSetSource over een TDataSet, beschrijf de banden met TsgcReportBuilder en roep SaveToPDF aan, zoals in het codevoorbeeld hierboven. Wil je liever de indeling tekenen, plaats dan een TsgcReport, een TsgcReportEngine en een TsgcVCLReportDesigner op een formulier, ontwerp het rapport en sla het op als JSON-definitie. Beide manieren leveren hetzelfde rapportmodel op.
Ja, in de Registered-editie. TsgcVCLReportDesigner en TsgcFMXReportDesigner zijn ontwerpers voor eindgebruikers die je in je formulieren insluit, en sgcShowReportDesigner opent er een modaal vanuit een menu. Voor webtoepassingen draait TsgcReportHTMLDesigner in de browser. Elke ontwerper slaat JSON-definities op die overal in sgcReports kunnen worden geladen.
Ja, in de Registered-editie. TsgcReportImporter converteert ReportBuilder-sjablonen (.rtm), als tekst of binair, en QuickReport-formulieren (.dfm met een TQuickRep) naar rapportdefinities, en toont elk object, elke eigenschap, expressie en elk script dat hij niet kon koppelen. De ontwerpers hebben een opdracht Import die hetzelfde doet. Zie Neem je bestaande rapportsjablonen mee.
Ja. SaveToPDF en SaveToXLSX op de builder, of TsgcReportPDFExport en TsgcReportXLSXExport op voorbereide pagina's, schrijven getagde PDF/UA-1 (PDF/A-3 op verzoek) en Excel-werkmappen die getallen als getallen behouden. CSV, PNG, HTML, ODS, SVG en platte tekst zitten in elke editie, en DOCX, ODT en RTF in de Registered-editie.
Wijs de engine toe aan een TsgcReportPreviewVCL en roep Prepare aan. Het voorbeeld bladert, zoomt, zoekt tekst en exporteert, en Print drukt het getoonde document af. FireMonkey-toepassingen gebruiken TsgcReportPreviewFMX op Windows, macOS, iOS en Android.
Ja. De kern heeft geen VCL- of FireMonkey-afhankelijkheid en geen externe DLL, dus TsgcReportEngine en de exports draaien in Windows-services en Linux64-daemons, met één engine per thread. De demo ReportLinuxDaemon maakt taken uit een map met 4 worker-threads.
Delphi 7 tot 13 en C++ Builder 2007 tot 13. TsgcReportBuilder is een gewone klasse die op Delphi 7 werkt, zonder dat anonieme methoden nodig zijn. De FireMonkey-ontwerper vereist Delphi XE6 of later. Dezelfde klassen zijn beschikbaar voor .NET.
Ja, altijd. sgcReports schrijft PDF en tekent barcodes met de sgcPDF-engine, en de voorbeelden tekenen via het sgcPDF-viewerbesturingselement. sgcUI Enterprise bevat beide.