sgcReports Feature Matrix
Everything sgcReports does, grouped by task, with a link to the help topic of each feature. The core has no VCL or FMX and no external DLL, so it runs in Windows services and Linux64 daemons.
Everything sgcReports does, grouped by task, with a link to the help topic of each feature. The core has no VCL or FMX and no external DLL, so it runs in Windows services and Linux64 daemons.
9 features
3 features
9 features
3 features
8 features
12 features
8 NuGet packages
Online help and PDF manuals
Registered marks the features that are in the Registered and Trial editions and not in the free .NET Community edition. ~ marks a feature that .NET Community has in part, with the difference below it.
Every row links to its help topic. Rows marked Registered need the Registered edition. The Web Bridge rows also need sgcWebSockets Professional or higher and sgcHTML.
| Feature | Details | .NET Community | Help |
|---|---|---|---|
| Fluent builder | TsgcReportBuilder builds a report in code with a fluent chain. | Help | |
| Report model | Fill the TsgcReport model directly. | Help | |
| JSON definitions | Load a report definition from JSON at run time without recompiling. | Help | |
| Bands and groups | Group headers and footers, master data, page footer, subtotals and page numbers. | Help | |
| Master detail | Master and detail bands, for example an invoice with its lines. | Help | |
| Expressions | Expressions such as Sum(Sales.Amount), with 68 functions and 10 aggregates for dates, text, numbers and conditional choices. | Help | |
| Number to words in 12 languages | ToWords writes a number as words in the 12 sgcUI languages, for amounts on cheques and invoices. | Help | |
| Running totals and conditional aggregates | SumIf and CountIf aggregate only the records that match a condition. Previous, RunningSum and RunningCount give the previous value and running totals and counts that restart with every group. | Help | |
| Scripting | TsgcReport.Script holds procedures in a small Pascal like language (variables, if, case, for, while, repeat and every expression function), stored in the report definition and the JSON. The report runs StartScript and FinishScript, each band runs BeforePrintScript, AfterPrintScript and AfterDataScript, and each item BeforePrintScript and AfterPrintScript. A script can hide a band, change the text, the font colour or the height of an item for the current print, read data fields and set report variables. ScriptMaxSteps stops a script that does not end, and ScriptErrorAction and OnScriptError decide what an error does. In Delphi, C++Builder and .NET. | Help | |
| Barcodes | Barcodes in reports through the sgcPDF barcode engine. | Help | |
| Right to left (Arabic and Hebrew) | TsgcReport.RightToLeft and BiDiMode on bands and items mirror the layout, with shaped, bidi ordered and justified text. The PDF export sets a right to left reading direction, XLSX writes a right to left sheet, and the HTML viewer and designer get dir="rtl". | Help | |
| Report import | TsgcReportImporter converts a FastReport VCL report (.fr3), a QuickReport form (.dfm with a TQuickRep) or a ReportBuilder template (.rtm), text or binary, into a TsgcReport or a JSON definition. It maps pages, bands, groups, text, image, line, shape, barcode, check box and subreport items, styles, highlights, data fields and expressions, and checks every translated expression with the sgcReports parser. DataSourceMap renames the data sources. What it cannot map is never dropped silently: ImportResult.Issues lists every object, property, expression, script and data source with its path and the original text, and a broken file raises ESgcReportImportError and leaves the report unchanged. The same file always gives the same JSON. The VCL, FireMonkey, WinForms, WPF and Avalonia designers have an Import command, and the ReportImport demo converts a file. No third party product has to be installed. Registered edition only. | Registered | Help |
| Feature | Details | .NET Community | Help |
|---|---|---|---|
| Accessible PDF | Tagged PDF/UA-1 by default (PDFUA is True). | Help | |
| PDF/A-3 | Archival PDF/A-3 on request (rpaA3b, rpaA3a). In Delphi and .NET, also PDF/A-4 (rpaA4) and PDF/UA-2 (PDFUAPart set to rpuPart2). | Help | |
| E-invoice PDF/A-3 (Factur-X, ZUGFeRD, XRechnung) | Embeds the invoice XML supplied by the application (Factur-X, ZUGFeRD and XRechnung profiles) as a PDF/A-3 associated file with the Factur-X metadata, through the EInvoice property. It also works with PDF/A-3a and PDF/UA for an accessible e-invoice, in every edition. The XML comes from the application, or from sgcSign, which creates, signs and submits real invoices. | Help | |
| XLSX, CSV and PNG | One prepared report, many outputs: TsgcReportXLSXExport, TsgcReportCSVExport and TsgcReportImageExport. | Help | |
| Preview | TsgcReportPreviewVCL and TsgcReportPreviewFMX with page navigation. The FireMonkey preview runs on Windows, macOS, iOS and Android, with touch pan and pinch zoom. On iOS and Android, Print and Save PDF open the share sheet of the system, which offers AirPrint or Android printing (SharePDF, Delphi 10.3 and later), and RenderPage draws any page into a bitmap on every platform. | Help | |
| Bookmarks and PDF outline | Set Bookmark, a text template, on a band or an item and each print of it adds an entry to the PDF outline, nested by group level. The VCL and FireMonkey previews, and the WinForms, WPF and Avalonia previews in .NET, show the outline in a pane (ShowOutline). | Help | |
| Hyperlinks and anchors | Set Hyperlink, a text template, on an item to link to a web page, a mailto: address or, with #name, an anchor, and set Anchor on a band or an item to name that anchor. The links stay clickable in the PDF, tagged for PDF/UA and PDF/A-3a, and are kept as links and element ids in HTML, as hyperlinks and bookmarks in Word DOCX and as cell hyperlinks in Excel XLSX. | Help | |
| Highlights (conditional styles) | Each item has a Highlights collection of conditional styles, each with a Condition expression and a StyleName. Each time the item prints, the first highlight whose condition is true replaces the item style, for example negative amounts in red or totals over a limit in bold, with no script. Highlights are stored in the JSON definition and the JSON Schema, and are editable in the designer. | Help | |
| Report inheritance | A report definition can inherit from a base definition with InheritsFrom ("inheritsFrom" in the JSON). One base definition (letterhead) feeds invoices, statements and delivery notes, and children store only their differences: pages, bands, items and styles merge by name, a child can override, add, remove and reorder objects, and saving writes only the differences from the base. The model, the JSON definitions and the fluent API are in every edition, .NET Community included. The support in the end-user designers and in the HTTP endpoint is Registered only. | Help | |
| Preview tools: find bar, page thumbnails, Export menu with OnExport | The Find button of TsgcReportPreviewVCL and TsgcReportPreviewFMX shows a find bar with Previous and Next, Match case and Whole word. Ctrl+F shows it, Enter and F3 go to the next match, and every match is highlighted. SearchText, SearchNext and SearchPrevious do the same from code. ShowThumbnails shows the page thumbnails instead of the outline, rendered only when they become visible. The Export menu saves the report as PDF, Excel, CSV, PNG, HTML, Word, ODT, ODS, RTF, SVG or plain text, ExportFormats chooses the items, ExportToFile and ExportWithDialog export from code, and OnExport sets the options of the export component, changes the file name or cancels the export. The buttons are in every edition, .NET Community included. The Word, ODT and RTF items need the Registered edition. The Export menu is desktop only in FireMonkey. | Help | |
| Report parameters with prompt | A report declares typed parameters (text, integer, number, date, date and time, yes or no) with a default value or expression, required and multiple values, and a value list from a static list or a data source. Expressions and scripts read them as :Name, and TsgcReportDataSetSource gives them to the SQL parameters of the data set, so the database returns only the rows needed. ParameterPrompt of the VCL and FireMonkey previews and designers asks for the values before the report is prepared, the HTML viewer shows a typed form, and TsgcReportHTTPEndpoint binds ?param.Name=value, answering 400 on a bad value. The model, the engine and the prompts are in every edition, .NET Community included. The HTTP endpoint needs sgcWebSockets Professional or higher. | Help | |
| Table item | A table item prints a grid inside its band: columns with fixed, percent or automatic widths, header, data and footer rows, rows that grow with their text, merged cells, and a style, display format, highlights and hyperlink for every cell. A data bound table has a data source of its own and prints its data rows once per record, with per-table totals in the footer rows such as [Sum(Lines.Amount)] and [Count()]. Header rows print again where the table continues on a new page or column. Every export writes a real table: tagged PDF with Table, TH and TD that passes PDF/UA, an HTML table, a Word table (the DOCX export is Registered only), CSV lines and an Excel grid with merged cells. The VCL, FireMonkey, web and WinForms, WPF and Avalonia designers have a table editor. Tables are in every edition, .NET Community included. | Help | |
| Progress and cancel | OnProgress reports the page and record counts while a report is prepared, and Cancel stops it, checked between bands. A cancelled report raises a silent abort exception (EsgcReportCancelled) and frees its pages. The VCL and FireMonkey previews, and the WinForms, WPF and Avalonia previews in .NET, show the progress while preparing with a Cancel button and Esc, and closing the window during a long report cancels it. TsgcReportHTTPEndpoint has MaxPages and Timeout limits and answers 503 when a report is cancelled. With no handler there is no measurable cost and the output is identical. | Help | |
| Linux daemon | Run the engine headless in a Linux64 daemon. | Help |
| Feature | Details | .NET Community | Help |
|---|---|---|---|
| Serve reports over HTTP | TsgcReportHTTPEndpoint serves reports as PDF, XLSX, CSV, HTML, DOCX, ODT, ODS, RTF and plain text files and as PNG or SVG pages. Needs sgcWebSockets Professional or higher and sgcHTML. | ~Delphi and C++ Builder: needs sgcWebSockets Professional or higher and sgcHTML. .NET: the esegece.sgcReports.HTML and AspNetCore packages host the same routes. | Help |
| Browser viewer | TsgcReportHTMLViewer shows reports in the browser. | Help | |
| Interactive web viewer | With Interactive set, TsgcReportHTMLViewer expands and collapses the group headers marked DrillDown (DrillExpanded sets the start state) and sorts the rows on the server when a column header with a SortExpression is clicked. A second click sorts them descending. A report: link such as report:region?param.Region=[Sales.Region] opens another report of the same endpoint with a Back button, and a parameter panel above or beside the page (ParametersPosition) checks each field and reruns the report in place. Every clickable area is a button or a link reachable with the keyboard and announced to screen readers. The downloads follow the sort and print every group expanded. | Help | |
| Web report designer | TsgcReportHTMLDesigner edits report definitions in the browser. | ~Leave DesignerEnabled off on production endpoints and put it behind your own authentication. | Help |
| Feature | Details | .NET Community | Help |
|---|---|---|---|
| Designer for VCL | TsgcVCLReportDesigner is a panel where your users edit reports inside your application. Drop it on a form, assign Engine and add the data sources. | Registered | Help |
| Designer for FireMonkey | TsgcFMXReportDesigner is the FireMonkey twin over the same designer units. The modal designer works on Windows and macOS. | Registered | Help |
| Toolbox, outline, data tree and inspector | Drag item kinds from the Toolbox and fields from the Data tree onto a band, browse pages, bands and items in the Outline, and edit properties in the inspector. Every drop is one undo step. | Registered | Help |
| Rulers, alignment and undo | A design surface with rulers and zoom, align and distribute commands, and undo and redo. | Registered | Help |
| Preview and JSON files | The Preview tab prepares the report with the data of the engine. New, Open and Save use JSON report definitions that a server can run headless. A modal designer with OK and Cancel is one call away. | Registered | Help |
| Localized designer | The texts of the designer are translated by sgcUISetLanguage into the 12 built-in languages of sgcUI. | Registered | Help |
| .NET designer classes | Designer controls for WinForms, WPF and Avalonia are included: TsgcWinFormsReportDesigner, TsgcWpfReportDesigner and TsgcAvaloniaReportDesigner, with toolbox, outline, data tree, property inspector, rulers and live preview, plus modal designer windows. They are built on the platform neutral designer model, which you can also use to build your own host. | Registered | Help |
| Script editor | The designers of VCL, FireMonkey, WinForms, WPF and Avalonia edit the report script in a code editor with a Check button that shows the line and column of an error. The inspector lists the script events of the report, the bands and the items, with the procedures of the script to choose from and a "(new procedure)" entry that adds an empty procedure. Script changes are part of undo and redo. | Registered | Help |
| Feature | Details | .NET Community | Help |
|---|---|---|---|
| Rich text | Bold, italic, colors, fonts, lists and links in one item, written as markup similar to HTML with [expressions]. Links are kept in the PDF, HTML and DOCX exports. | Help | |
| Watermarks | A text or image watermark on every report page, with opacity, rotation, centered, tiled or custom position, behind or in front of the content, page ranges and a visibility expression. | Help | |
| Crosstab tables | Row and column fields, several measures (sum, count, average, minimum and maximum), totals, and an accessible table in PDF/UA and HTML. Columns that do not fit continue on the following pages. | Help | |
| Custom item types | Register your own TsgcReportCustomRenderer by name. It prints in the PDF, PNG, HTML and DOCX exports and appears in the designer Toolbox. The ready-made Chart, Sparkline, Gauge and PivotTable bridges are Registered. | Help | |
| Charts in reports | The sgcReportsCharts bridge adds a Chart item drawn by sgcCharts: bar, stacked bar, line and area, as vector content in PDF and inline SVG in HTML. Requires sgcCharts. | Registered | Help |
| Pivot tables in reports | The sgcReportsPivotGrid bridge adds a PivotTable item calculated by sgcPivotGrid, with more aggregates than the built-in crosstab. Requires sgcPivotGrid. | Registered | Help |
| Check box item | A check box item prints a square box with a check mark, a cross or a filled square. A Boolean expression such as Orders.Paid or Orders.Amount > 100 is evaluated every time the item prints, for example for every record, or a fixed value is used. The box has its own size, colors and fill. It prints as vector paths in PDF (a Figure in tagged PDF/UA with the text Checked or Not checked), as an inline SVG in HTML, as a symbol in DOCX and as a TRUE or FALSE value in XLSX and CSV. The designers have a Check box entry in the palette. Check boxes are in every edition, .NET Community included. | Help | |
| SVG pictures | An image item prints an SVG picture from Image.Picture, a file or a data field, with no new property. In PDF the picture stays vector, so logos print sharp at any zoom, and the HTML export writes it as an image with the alt text of the item. DOCX gets a PNG picture and the designers draw the SVG as vectors. Paths, shapes, transforms, viewBox, fill, stroke and opacity are drawn, text, gradients and filters are not. SVG pictures are in every edition, .NET Community included. The .NET Community edition prints them in HTML but not in PDF. | Help | |
| Sparklines in reports | The sgcReportsCharts bridge adds a Sparkline item drawn by sgcCharts: line, area, column or win and loss, with markers for the first, last, high, low and negative points, a reference line and a shaded band. The values come from a list or from a data source, and every setting can hold [expressions], so a data band prints one sparkline per record. It is vector content in PDF and inline SVG in HTML. Requires sgcCharts. | Registered | Help |
| Gauges in reports | The sgcReportsGauges bridge adds a Gauge item drawn by sgcGauges: a radial gauge with a needle or a linear gauge with a bar, with colored ranges, a caption, a unit and the value as text. The value is an expression, a field of the record or an aggregate such as [Sum(Sales.Amount)] in a summary band. It is vector content in PDF and inline SVG in HTML. Requires sgcGauges. | Registered | Help |
| HTML export | TsgcReportHTMLExport writes one self contained HTML file, paged or continuous. The semantic mode writes headings, paragraphs and ARIA tables and hides decorative items from assistive technology. | Help | |
| DOCX export | TsgcReportDOCXExport writes a Word document, either with the layout fixed in exact frames or as a flowing, editable table. No external zip library is needed. | Registered | Help |
| OpenDocument export: ODT text (Registered) and ODS spreadsheet | TsgcReportODTExport writes an OpenDocument text file (ODF 1.2), with every object fixed at its place on the page or, with Mode set to omFlow, as one editable table. TsgcReportODSExport writes an OpenDocument spreadsheet with typed number cells, merged cells and the styles of the report. No external zip library is needed. | ~ODS in every edition. ODT needs the Registered edition, as DOCX. | ODT, ODS |
| RTF export (Registered) | TsgcReportRTFExport writes Rich Text Format for older word processors and for applications that only read RTF: positioned frames, drawing shapes and pictures, with one section per page size, or with Mode set to rmFlow the layout as one table. The file is plain ASCII and GetRTF returns it as a string. | Registered | Help |
| SVG export: one vector page per file | TsgcReportSVGExport writes every prepared page as an SVG 1.1 file sized in points. Text stays text, shapes, lines, barcodes and check boxes are vectors, and pictures are embedded. SaveToFiles writes one file per page from a name such as page%d.svg, and GetSVG returns one page as a string. | Help | |
| Plain text export on a character grid with form feeds | TsgcReportTextExport writes the report as UTF-8 plain text on a character grid, for line printers and logs. CharWidth and LineHeight, or Columns, set the grid, a form feed separates the pages (FormFeed), and LineBreak and WriteBOM shape the file. GetText returns the text as a string. | Help |
The .NET reports are a C# port with the same class names: the builder, JSON source, engine and exports, a WinForms preview, and HTML, ASP.NET Core and sgcSign packages.
| Package | Edition | Contents |
|---|---|---|
esegece.sgcReports.Community | Community (free) | Core library |
esegece.sgcReports.WinForms.Community | Community (free) | Windows Forms controls |
esegece.sgcReports.HTML.Community | Community (free) | HTML viewer and web integration |
esegece.sgcReports.AspNetCore.Community | Community (free) | ASP.NET Core integration |
esegece.sgcReports.Wpf.Community | Community (free) | WPF controls |
esegece.sgcReports.Avalonia.Community | Community (free) | Avalonia controls |
esegece.sgcReports.sgcSign.Community | Community (free) | sgcSign bridge, signs the PDF exports (PAdES) |
esegece.sgcReports | Registered | Core library |
esegece.sgcReports.WinForms | Registered | Windows Forms controls |
esegece.sgcReports.HTML | Registered | HTML viewer and web integration |
esegece.sgcReports.AspNetCore | Registered | ASP.NET Core integration |
esegece.sgcReports.Wpf | Registered | WPF controls |
esegece.sgcReports.Avalonia | Registered | Avalonia controls |
esegece.sgcReports.sgcCharts | Registered only | sgcCharts bridge, the Chart and Sparkline items |
esegece.sgcReports.sgcGauges | Registered only | sgcGauges bridge, the Gauge item |
esegece.sgcReports.sgcPivotGrid | Registered only | sgcPivotGrid bridge, the PivotTable item |
esegece.sgcReports.sgcSign | Registered | sgcSign bridge, signs the PDF exports (PAdES) |
Every feature of sgcReports is documented in the sgcUI help, with one build for each development environment.
Start with the sgcReports introduction, then follow the quick start and the feature topics.
Delphi →The complete sgcUI help as a PDF file, to read offline or print.
Delphi (PDF) →