Article technique

HotXLS Component: template-based report generation in Delphi

Cet article français présente HotXLS Component: template-based report generation in Delphi pour les équipes qui construisent des solutions avec Delphi, C++Builder, Lazarus/FPC et les composants losLab

L'accent est mis sur les choix pratiques, les pièges et les points de contrôle afin que la solution reste fiable en production

Décisions d'architecture

Make templates part of the application interface. placeholder syntax, required values, repeated regions, and named-range ownership / style preservation, formula refresh, merged-cell behavior, and row insertion rules

  • placeholder syntax, required values, repeated regions, and named-range ownership
  • style preservation, formula refresh, merged-cell behavior, and row insertion rules
  • localization of labels, number formats, dates, and sheet names
  • template versioning, approval, rollback, and compatibility with old data profiles

Parcours d'implémentation

Bind placeholders to typed data contracts. The order below keeps the workflow reviewable for Delphi and C++Builder teams.

  1. validate template version and required placeholders before loading data
  2. bind typed data to named ranges or placeholder regions
  3. expand repeating sections while preserving formulas, styles, merges, and page breaks
  4. calculate and validate key cells after data insertion
  5. store template version and placeholder results with the generated workbook

Preuves de validation

Template evidence that speeds up support. Keep these fields with the output or support record.

  • template version, data profile, placeholder list, and missing-placeholder warnings
  • expanded region sizes, inserted rows, formula refresh status, and style preservation
  • localized label set and number-format profile
  • regression workbook comparison against approved samples

A template is executable design

A workbook template carries layout, formatting, formulas, and business assumptions. The code should treat placeholders, named ranges, and repeating regions as a documented contract rather than free-form cell addresses.

Notes d'implémentation en production

Traitez HotXLS Component: template-based report generation in Delphi comme un contrat de service explicite autour des appels HotXLS, en séparant validation d'entrée, écriture du classeur, contrôle de sortie et preuves de support

  • Définir la source de données, les plages de cellules et le format de sortie avant de créer le classeur
  • Consigner le nombre de lignes, les feuilles, les avertissements et le chemin de sortie dans une trace relisible
  • Encapsuler les détails applicatifs dans des helpers testables plutôt que dans des événements UI
  • Rouvrir ou inspecter le fichier enregistré avant livraison à un autre système ou au client

Défaillances à répéter en test

  • Un SaveAs réussi ne prouve pas que le contrat métier est respecté
  • Polices, droits et paramètres régionaux peuvent différer entre serveur et poste de développement
  • Les journaux ne doivent exposer ni mots de passe, ni données client, ni liens internes

Exemple Delphi détaillé

L'exemple Delphi suivant montre une frontière de service pratique pour ce sujet, avec politiques, journalisation et validation dans une couche testable

procedure GenerateReportFromTemplate(const TemplateFile, OutputFile: string; const Context: TReportContext);
var
  Wb: TXLSXWorkbook;
begin
  RequireFileExists(TemplateFile);
  Wb := TXLSXWorkbook.Create;
  try
    Wb.Open(TemplateFile);
    EnsureTemplateVersion(Wb, Context.TemplateVersion);
    SetNamedValue(Wb, 'ReportTitle', Context.Title);
    SetNamedValue(Wb, 'ReportPeriod', Context.PeriodText);
    FillNamedTable(Wb, 'RevenueRows', Context.RevenueRows);
    FillNamedTable(Wb, 'ExpenseRows', Context.ExpenseRows);
    Wb.Calculate;

    AssertNoUnresolvedTemplateMarkers(Wb);
    AssertRequiredSheetsVisible(Wb, ['Cover', 'Summary', 'Detail']);
    WriteGenerationAudit(Wb, Context);

    if Wb.SaveAs(OutputFile) <> 1 then
      RaiseWorkbookSaveError(OutputFile);
  finally
    Wb.Free;
  end;
end;

Liste de mise en production

  • Run the workflow on an empty workbook, a normal customer workbook, and a worst-case workbook
  • Open the output with the target spreadsheet application or downstream importer
  • Log product version, template version, profile, row count, output path, elapsed time, and warning count
  • Keep passwords, temporary files, customer data, and support bundles under explicit retention rules
  • Add regression workbooks when a customer file exposes a new edge case

Product documentation

HotXLS Component

Exemples de code supplémentaires

const
  DetailRow = 10;            // the formatted sample row in the template
var
  I: Integer;
begin
  // Open space before the totals block first, so the SUM range
  // below the detail band stretches together with the data.
  if Length(Items) > 1 then
    Sheet.InsertRows(DetailRow + 1, Length(Items) - 1);

  for I := 0 to High(Items) do
  begin
    if I > 0 then              // clone styles + formulas from the sample row
      Sheet.CopyRange(DetailRow, 1, DetailRow, 5, DetailRow + I, 1);
    Sheet.Cells[DetailRow + I, 1].Value := Items[I].Name;
    Sheet.Cells[DetailRow + I, 2].Value := Items[I].Qty;
    Sheet.Cells[DetailRow + I, 3].Value := Items[I].UnitPrice;
    Sheet.Cells[DetailRow + I, 4].Formula :=
      Format('B%d*C%d', [DetailRow + I, DetailRow + I]);  // no '=' prefix
  end;
end;
var
  Total: Variant;
  LastDetail: Integer;
begin
  LastDetail := DetailRow + Length(Items) - 1;
  Total := Book.Calculate(Format('SUM(Invoice!D%d:D%d)',
    [DetailRow, LastDetail]));
  if (not VarIsNumeric(Total)) or
     (Abs(Total - ExpectedTotal) > 0.005) then
    raise Exception.Create('Invoice total does not match the order record');

  if Book.SaveAs('invoice-2026-0611.xlsx') <> 1 then
    raise Exception.Create('Save failed: check output path and permissions');
end;