Tout ce que fait sgcReports, groupé par tâche, avec un lien vers la rubrique d'aide de chaque fonctionnalité. Le noyau n'a ni VCL ni FMX et aucune DLL externe, donc il fonctionne dans les services Windows et les démons Linux64.
Enregistrée signale les fonctionnalités présentes dans les éditions enregistrée et d'essai, mais pas dans l'édition .NET Community gratuite. ~ signale une fonctionnalité que .NET Community propose en partie, avec la différence indiquée en dessous.
Chaque ligne renvoie vers son sujet d'aide. Les lignes marquées Enregistrée nécessitent l'édition enregistrée. Les lignes du pont web nécessitent aussi sgcWebSockets Professional ou supérieur et sgcHTML.
FONCTIONNALITÉS
Définition du rapport
Fonctionnalité
Détails
.NET Community
Aide
Constructeur fluent
TsgcReportBuilder construit un rapport dans le code avec une chaîne fluent.
SumIf et CountIf n'agrègent que les enregistrements qui remplissent une condition. Previous, RunningSum et RunningCount donnent la valeur précédente ainsi que des cumuls et des compteurs qui repartent à zéro à chaque groupe.
TsgcReport.Script contient des procédures dans un petit langage proche de Pascal (variables, if, case, for, while, repeat et toutes les fonctions d'expression), stockées dans la définition du rapport et dans le JSON. Le rapport exécute StartScript et FinishScript, chaque bande exécute BeforePrintScript, AfterPrintScript et AfterDataScript, et chaque élément BeforePrintScript et AfterPrintScript. Un script peut masquer une bande, changer le texte, la couleur de police ou la hauteur d'un élément pour l'impression en cours, lire des champs de données et définir des variables du rapport. ScriptMaxSteps arrête un script qui ne se termine pas, et ScriptErrorAction et OnScriptError décident de l'effet d'une erreur. En Delphi, C++Builder et .NET.
TsgcReport.RightToLeft et BiDiMode sur les bandes et les éléments mettent la disposition en miroir, avec un texte mis en forme, ordonné en bidi et justifié. L'export PDF définit un sens de lecture de droite à gauche, XLSX écrit une feuille de droite à gauche, et le visualiseur et le concepteur HTML reçoivent dir="rtl".
TsgcReportImporter convertit un état FastReport VCL (.fr3), un formulaire QuickReport (.dfm avec un TQuickRep) ou un modèle ReportBuilder (.rtm), au format texte ou binaire, en un TsgcReport ou une définition JSON. Il associe les pages, bandes, groupes, éléments texte, image, ligne, forme, code-barres, case à cocher et sous-état, les styles, les mises en évidence, les champs de données et les expressions, et vérifie chaque expression traduite avec l'analyseur de sgcReports. DataSourceMap renomme les sources de données. Ce qui ne peut pas être associé n'est jamais supprimé en silence : ImportResult.Issues liste chaque objet, propriété, expression, script et source de données avec son chemin et le texte d'origine, et un fichier corrompu lève ESgcReportImportError et laisse l'état inchangé. Le même fichier donne toujours le même JSON. Les concepteurs VCL, FireMonkey, WinForms, WPF et Avalonia ont une commande Importer, et la démo ReportImport convertit un fichier. Aucun produit tiers n'a besoin d'être installé. Édition enregistrée uniquement.
Incorpore le XML de la facture fourni par l'application (profils Factur-X, ZUGFeRD et XRechnung) comme fichier associé PDF/A-3 avec les métadonnées Factur-X, via la propriété EInvoice. Fonctionne aussi avec PDF/A-3a et PDF/UA pour une facture électronique accessible, dans toutes les éditions. Le XML vient de l'application ou de sgcSign, qui crée, signe et soumet de vraies factures.
TsgcReportPreviewVCL et TsgcReportPreviewFMX avec navigation entre les pages. L'aperçu FireMonkey fonctionne sous Windows, macOS, iOS et Android, avec défilement tactile et zoom par pincement. Sous iOS et Android, Imprimer et Enregistrer en PDF ouvrent la feuille de partage du système, qui propose AirPrint ou l'impression Android (SharePDF, Delphi 10.3 et ultérieur), et RenderPage dessine n'importe quelle page dans un bitmap sur toutes les plateformes.
Définissez Bookmark, un modèle de texte, sur une bande ou un élément, et chaque impression ajoute une entrée au plan du PDF, imbriquée par niveau de groupe. Les aperçus VCL et FireMonkey, ainsi que ceux de WinForms, WPF et Avalonia dans .NET, affichent le plan dans un volet (ShowOutline).
Définissez Hyperlink, un modèle de texte, sur un élément pour pointer vers une page web, une adresse mailto: ou, avec #name, une ancre, et définissez Anchor sur une bande ou un élément pour nommer cette ancre. Les liens restent cliquables dans le PDF, balisé pour PDF/UA et PDF/A-3a, et sont conservés comme liens et identifiants d'élément en HTML, comme liens hypertexte et signets dans Word DOCX et comme liens hypertexte de cellule dans Excel XLSX.
Chaque élément a une collection Highlights de styles conditionnels, chacun avec une expression Condition et un StyleName. À chaque impression de l'élément, le premier highlight dont la condition est vraie remplace le style de l'élément, par exemple les montants négatifs en rouge ou les totaux au-dessus d'une limite en gras, sans script. Les highlights sont enregistrés dans la définition JSON et dans le JSON Schema, et se modifient dans le concepteur.
Une définition d'état peut hériter d'une définition de base avec InheritsFrom ("inheritsFrom" dans le JSON). Une définition de base (papier à en-tête) alimente les factures, les relevés et les bons de livraison, et les enfants ne stockent que leurs différences : les pages, bandes, éléments et styles sont fusionnés par nom, un enfant peut remplacer, ajouter, supprimer et réordonner des objets, et l'enregistrement n'écrit que les différences par rapport à la base. Le modèle, les définitions JSON et l'API fluide sont présents dans toutes les éditions, y compris .NET Community. La prise en charge dans les concepteurs pour l'utilisateur final et dans le point de terminaison HTTP est réservée à Registered.
Outils d’aperçu : barre de recherche, miniatures de pages, menu Exporter avec OnExport
Le bouton Rechercher de TsgcReportPreviewVCL et TsgcReportPreviewFMX affiche une barre de recherche avec Précédent et Suivant, Respecter la casse et Mot entier. Ctrl+F l’affiche, Enter et F3 passent à l’occurrence suivante, et chaque occurrence est surlignée. SearchText, SearchNext et SearchPrevious font de même depuis le code. ShowThumbnails affiche les miniatures des pages à la place du plan, rendues seulement lorsqu’elles deviennent visibles. Le menu Exporter enregistre l’état en PDF, Excel, CSV, PNG, HTML, Word, ODT, ODS, RTF, SVG ou texte brut, ExportFormats choisit les éléments, ExportToFile et ExportWithDialog exportent depuis le code, et OnExport définit les options du composant d’export, change le nom du fichier ou annule l’export. Les boutons sont dans toutes les éditions, .NET Community comprise. Les éléments Word, ODT et RTF nécessitent l’édition Registered. Le menu Exporter est réservé au bureau dans FireMonkey.
Un rapport déclare des paramètres typés (texte, entier, nombre, date, date et heure, oui ou non) avec une valeur ou une expression par défaut, des valeurs obligatoires et multiples, et une liste de valeurs issue d'une liste statique ou d'une source de données. Les expressions et les scripts les lisent sous la forme :Name, et TsgcReportDataSetSource les transmet aux paramètres SQL du jeu de données, si bien que la base de données ne renvoie que les lignes nécessaires. ParameterPrompt des aperçus et des concepteurs VCL et FireMonkey demande les valeurs avant la préparation du rapport, le visualiseur HTML affiche un formulaire typé et TsgcReportHTTPEndpoint lie ?param.Name=value, en répondant 400 pour une valeur incorrecte. Le modèle, le moteur et les invites sont présents dans toutes les éditions, .NET Community comprise. Le point de terminaison HTTP nécessite sgcWebSockets Professional ou supérieur.
Un élément de tableau imprime une grille dans sa bande : colonnes de largeur fixe, en pourcentage ou automatique, lignes d'en-tête, de données et de pied, lignes qui grandissent avec leur texte, cellules fusionnées et, pour chaque cellule, un style, un format d'affichage, des surlignages et un lien hypertexte. Un tableau lié aux données possède sa propre source de données et imprime ses lignes de données une fois par enregistrement, avec des totaux par tableau dans les lignes de pied, comme [Sum(Lines.Amount)] et [Count()]. Les lignes d'en-tête sont imprimées à nouveau lorsque le tableau continue sur une nouvelle page ou colonne. Chaque export écrit un vrai tableau : PDF balisé avec Table, TH et TD qui réussit PDF/UA, un tableau HTML, un tableau Word (l'export DOCX est réservé à Registered), des lignes CSV et une grille Excel avec cellules fusionnées. Les concepteurs VCL, FireMonkey, web et WinForms, WPF et Avalonia disposent d'un éditeur de tableaux. Les tableaux sont dans toutes les éditions, .NET Community comprise.
OnProgress signale les compteurs de pages et d'enregistrements pendant la préparation d'un état, et Cancel l'arrête, avec une vérification entre les bandes. Un état annulé lève une exception d'abandon silencieuse (EsgcReportCancelled) et libère ses pages. Les aperçus VCL et FireMonkey, ainsi que les aperçus WinForms, WPF et Avalonia en .NET, affichent la progression pendant la préparation avec un bouton Annuler et Échap, et fermer la fenêtre pendant un long état l'annule. TsgcReportHTTPEndpoint a les limites MaxPages et Timeout et répond 503 lorsqu'un état est annulé. Sans gestionnaire, il n'y a aucun coût mesurable et la sortie est identique.
TsgcReportHTTPEndpoint diffuse les rapports en fichiers PDF, XLSX, CSV, HTML, DOCX, ODT, ODS, RTF et texte brut et en pages PNG ou SVG. Nécessite sgcWebSockets Professional ou supérieur et sgcHTML.
~Delphi et C++ Builder : exige sgcWebSockets Professional ou supérieur et sgcHTML. .NET : les paquets esegece.sgcReports.HTML et AspNetCore hébergent les mêmes routes.
Avec Interactive activé, TsgcReportHTMLViewer déplie et replie les en-têtes de groupe marqués DrillDown (DrillExpanded fixe l'état de départ) et trie les lignes sur le serveur lorsqu'on clique sur un en-tête de colonne doté d'un SortExpression. Un second clic les trie par ordre décroissant. Un lien report: tel que report:region?param.Region=[Sales.Region] ouvre un autre rapport du même point de terminaison avec un bouton Back, et un panneau de paramètres au-dessus ou à côté de la page (ParametersPosition) vérifie chaque champ et relance le rapport sur place. Chaque zone cliquable est un bouton ou un lien accessible au clavier et annoncé aux lecteurs d'écran. Les téléchargements suivent le tri et impriment chaque groupe déplié.
TsgcVCLReportDesigner est un panneau avec lequel vos utilisateurs modifient les rapports dans votre application. Déposez-le sur une fiche, affectez Engine et ajoutez les sources de données.
Boîte à outils, plan, arbre de données et inspecteur
Faites glisser les types d'élément depuis la boîte à outils et les champs depuis l'arbre de données vers une bande, parcourez pages, bandes et éléments dans le plan et modifiez les propriétés dans l'inspecteur. Chaque dépôt est une étape d'annulation.
L'onglet Aperçu prépare le rapport avec les données du moteur. Nouveau, Ouvrir et Enregistrer utilisent des définitions JSON qu'un serveur peut exécuter sans interface. Un concepteur modal avec OK et Annuler tient en un appel.
Des contrôles de conception pour WinForms, WPF et Avalonia sont inclus : TsgcWinFormsReportDesigner, TsgcWpfReportDesigner et TsgcAvaloniaReportDesigner, avec boîte à outils, plan, arborescence des données, inspecteur de propriétés, règles et aperçu en direct, ainsi que des fenêtres de conception modales. Ils reposent sur le modèle de conception indépendant de la plateforme, que vous pouvez aussi utiliser pour construire votre propre hôte.
Les concepteurs VCL, FireMonkey, WinForms, WPF et Avalonia modifient le script du rapport dans un éditeur de code doté d'un bouton Vérifier qui indique la ligne et la colonne d'une erreur. L'inspecteur liste les événements de script du rapport, des bandes et des éléments, avec les procédures du script à choisir et une entrée « (nouvelle procédure) » qui ajoute une procédure vide. Les modifications du script font partie de l'annulation et du rétablissement.
Gras, italique, couleurs, polices, listes et liens dans un seul élément, écrits avec un balisage proche du HTML et des [expressions]. Les liens sont conservés dans les exports PDF, HTML et DOCX.
Un filigrane de texte ou d'image sur chaque page du rapport, avec opacité, rotation, position centrée, en mosaïque ou personnalisée, derrière ou devant le contenu, plages de pages et expression de visibilité.
Champs de ligne et de colonne, plusieurs mesures (somme, nombre, moyenne, minimum et maximum), totaux et un tableau accessible en PDF/UA et HTML. Les colonnes qui ne tiennent pas se poursuivent sur les pages suivantes.
Enregistrez votre propre TsgcReportCustomRenderer sous un nom. Il s'imprime dans les exports PDF, PNG, HTML et DOCX et apparaît dans la boîte à outils du concepteur. Les ponts Chart, Sparkline, Gauge et PivotTable prêts à l'emploi relèvent de l'édition enregistrée.
Le pont sgcReportsCharts ajoute un élément Chart dessiné par sgcCharts : barres, barres empilées, courbes et aires, en contenu vectoriel dans le PDF et en SVG en ligne dans le HTML. Nécessite sgcCharts.
Le pont sgcReportsPivotGrid ajoute un élément PivotTable calculé par sgcPivotGrid, avec plus d'agrégats que le tableau croisé intégré. Nécessite sgcPivotGrid.
Un élément case à cocher imprime une case carrée avec une coche, une croix ou un carré plein. Une expression booléenne telle que Orders.Paid ou Orders.Amount > 100 est évaluée à chaque impression de l'élément, par exemple pour chaque enregistrement, ou bien une valeur fixe est utilisée. La case a sa propre taille, ses couleurs et son remplissage. Elle s'imprime en tracés vectoriels dans le PDF (une Figure dans le PDF/UA balisé avec le texte "Checked" ou "Not checked"), en SVG en ligne dans le HTML, en symbole dans le DOCX et en valeur TRUE ou FALSE dans XLSX et CSV. Les concepteurs ont une entrée Case à cocher dans la palette. Les cases à cocher sont dans toutes les éditions, .NET Community comprise.
Un élément image imprime une image SVG issue de Image.Picture, d'un fichier ou d'un champ de données, sans nouvelle propriété. Dans le PDF, l'image reste vectorielle, de sorte que les logos s'impriment nets à tout zoom, et l'export HTML l'écrit comme une image avec le texte alternatif de l'élément. Le DOCX reçoit une image PNG et les concepteurs dessinent le SVG en vecteurs. Les tracés, formes, transformations, viewBox, remplissage, contour et opacité sont dessinés, le texte, les dégradés et les filtres ne le sont pas. Les images SVG sont dans toutes les éditions, .NET Community comprise. L'édition .NET Community les imprime dans le HTML mais pas dans le PDF.
Le pont sgcReportsCharts ajoute un élément Sparkline dessiné par sgcCharts : ligne, aire, colonne ou gain et perte, avec des repères pour le premier, le dernier, le plus haut, le plus bas et les points négatifs, une ligne de référence et une bande ombrée. Les valeurs viennent d'une liste ou d'une source de données, et chaque réglage peut contenir des [expressions], si bien qu'une bande de données imprime une sparkline par enregistrement. C'est du contenu vectoriel dans le PDF et du SVG en ligne dans le HTML. Nécessite sgcCharts.
Le pont sgcReportsGauges ajoute un élément Gauge dessiné par sgcGauges : une jauge radiale avec aiguille ou une jauge linéaire avec barre, avec des plages colorées, une légende, une unité et la valeur sous forme de texte. La valeur est une expression, un champ de l'enregistrement ou un agrégat tel que [Sum(Sales.Amount)] dans une bande de synthèse. C'est du contenu vectoriel dans le PDF et du SVG en ligne dans le HTML. Nécessite sgcGauges.
TsgcReportHTMLExport écrit un seul fichier HTML autonome, paginé ou continu. Le mode sémantique écrit titres, paragraphes et tableaux ARIA et masque les éléments décoratifs aux technologies d'assistance.
TsgcReportDOCXExport écrit un document Word, avec la mise en page figée dans des cadres exacts ou sous forme de tableau fluide et modifiable. Aucune bibliothèque zip externe n'est nécessaire.
Export OpenDocument : texte ODT (Registered) et feuille de calcul ODS
TsgcReportODTExport écrit un fichier texte OpenDocument (ODF 1.2), avec chaque objet fixé à sa place sur la page ou, avec Mode défini sur omFlow, sous forme d'un tableau modifiable. TsgcReportODSExport écrit une feuille de calcul OpenDocument avec des cellules numériques typées, des cellules fusionnées et les styles du rapport. Aucune bibliothèque zip externe n'est nécessaire.
~ODS dans toutes les éditions. ODT nécessite l'édition Registered, comme DOCX.
TsgcReportRTFExport écrit du Rich Text Format pour les traitements de texte plus anciens et pour les applications qui ne lisent que le RTF : cadres positionnés, formes de dessin et images, avec une section par taille de page ou, avec Mode défini sur rmFlow, la mise en page sous forme d'un tableau. Le fichier est de l'ASCII pur et GetRTF le renvoie sous forme de chaîne.
TsgcReportSVGExport écrit chaque page préparée sous forme d'un fichier SVG 1.1 dimensionné en points. Le texte reste du texte, les formes, lignes, codes-barres et cases à cocher sont des vecteurs, et les images sont incorporées. SaveToFiles écrit un fichier par page à partir d'un nom tel que page%d.svg, et GetSVG renvoie une page sous forme de chaîne.
Export en texte brut sur une grille de caractères avec sauts de page
TsgcReportTextExport écrit le rapport en texte brut UTF-8 sur une grille de caractères, pour les imprimantes en ligne et les journaux. CharWidth et LineHeight, ou Columns, fixent la grille, un saut de page sépare les pages (FormFeed), et LineBreak et WriteBOM façonnent le fichier. GetText renvoie le texte sous forme de chaîne.
Les rapports .NET sont un portage C# avec les mêmes noms de classes : le constructeur, la source JSON, le moteur et les exports, un aperçu WinForms, et des paquets HTML, ASP.NET Core et sgcSign.
Paquet
Édition
Contenu
esegece.sgcReports.Community
Community (gratuite)
Bibliothèque principale
esegece.sgcReports.WinForms.Community
Community (gratuite)
Contrôles Windows Forms
esegece.sgcReports.HTML.Community
Community (gratuite)
Visionneuse HTML et intégration web
esegece.sgcReports.AspNetCore.Community
Community (gratuite)
Intégration ASP.NET Core
esegece.sgcReports.Wpf.Community
Community (gratuite)
Contrôles WPF
esegece.sgcReports.Avalonia.Community
Community (gratuite)
Contrôles Avalonia
esegece.sgcReports.sgcSign.Community
Community (gratuite)
passerelle sgcSign, signe les exports PDF (PAdES)
esegece.sgcReports
Enregistrée
Bibliothèque principale
esegece.sgcReports.WinForms
Enregistrée
Contrôles Windows Forms
esegece.sgcReports.HTML
Enregistrée
Visionneuse HTML et intégration web
esegece.sgcReports.AspNetCore
Enregistrée
Intégration ASP.NET Core
esegece.sgcReports.Wpf
Enregistrée
Contrôles WPF
esegece.sgcReports.Avalonia
Enregistrée
Contrôles Avalonia
esegece.sgcReports.sgcCharts
Enregistrée uniquement
passerelle sgcCharts, les éléments Chart et Sparkline
esegece.sgcReports.sgcGauges
Enregistrée uniquement
passerelle sgcGauges, l'élément Gauge
esegece.sgcReports.sgcPivotGrid
Enregistrée uniquement
passerelle sgcPivotGrid, l'élément PivotTable
esegece.sgcReports.sgcSign
Enregistrée
passerelle sgcSign, signe les exports PDF (PAdES)
DOCUMENTATION
Documentation
Chaque fonctionnalité de sgcReports est documentée dans l'aide de sgcUI, avec une version pour chaque environnement de développement.
Aide en ligne
Commence par l'introduction de sgcReports, puis suis le démarrage rapide et les rubriques sur les fonctionnalités.