Teknisk artikel

HotXLS Component: template-based report generation in Delphi

Skapa, redigera, granska, beräkna och exportera Excel-arbetsböcker direkt från Delphi- eller C++Builder-kod. HotXLS är ett nativt Object Pascal-bibliotek med källkod för XLS- och XLSX-flöden, avsett för skrivbordsverktyg, batchjobb, rapportsystem och serversidig dokumentgenerering utan Microsoft Excel-automatisering.

Den här artikeln är skriven för teams producing customer-facing workbooks from maintained Excel templates rather than assembling every cell in code. Den behandlar template-based report generation som produktionsnära dokumentteknik, inte som ett isolerat komponentanrop.

Den praktiska risken är att template-driven output becomes fragile when placeholder ownership, dynamic rows, styles, formulas, and localization are not versioned. Därför behöver flödet ett skrivet kontrakt, observerbar diagnostik och realistiska regressionsfiler.

Arkitekturbeslut

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

Implementeringsflöde

Bind placeholders to typed data contracts. Ordningen nedan gör arbetsflödet granskbart för Delphi- och C++Builder-team.

  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

Valideringsbevis

Template evidence that speeds up support. Behåll dessa fält tillsammans med utdata eller supportunderlaget.

  • 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.

Implementeringsanteckningar för produktion

Behandla HotXLS Component: template-based report generation in Delphi som ett tydligt servicekontrakt runt HotXLS-anropen, med separerad indatavalidering, arbetsboksskrivning, utdata kontroll och supportbevis

  • Bestäm datakälla, cellområden och utdataformat innan arbetsboken skapas
  • Logga rader, blad, varningar och utdata sökväg i granskningsbar supportevidens
  • Kapsla applikationsdetaljer i testbara helpers i stället för UI-händelser
  • Öppna eller inspektera den sparade filen innan den lämnas till ett annat system eller kunden

Felmoder att öva

  • En lyckad SaveAs bevisar inte att affärskontraktet fortfarande är korrekt
  • Typsnitt, behörigheter och regionala inställningar kan skilja mellan server och utvecklingsdator
  • Loggar får inte exponera lösenord, kunddata eller interna länkar

Detaljerat Delphi-exempel

Följande Delphi-exempel visar en praktisk servicegräns för ämnet och håller policy, loggning och validering testbart separerade

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;

Produktionschecklista

  • 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

Produktdokumentation

HotXLS Component

Fler kodexempel

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;