HotXLS: formula calculation and custom functions in Delphi

Dieser deutsche Artikel behandelt HotXLS: formula calculation and custom functions in Delphi für Teams, die mit Delphi, C++Builder, Lazarus/FPC und losLab-Komponenten arbeiten

Der Fokus liegt auf praxisnahen Entscheidungen, Fallstricken und Prüfpunkten, damit die Lösung im produktiven Einsatz verlässlich bleibt

Architekturentscheidungen

Treat calculation as a deterministic service. calculation mode, dependency refresh, and whether cached values are trusted / custom function names, argument types, null handling, and versioning

• calculation mode, dependency refresh, and whether cached values are trusted
• custom function names, argument types, null handling, and versioning
• locale handling for decimal separators, date literals, and function names
• error-value policy for invalid references, division by zero, and unsupported formulas

Implementierungsablauf

Register custom functions before loading dependent formulas. The order below keeps the workflow reviewable for Delphi and C++Builder teams.

1. register custom functions and workbook names before calculation
2. load or generate formulas with explicit dependency expectations
3. calculate targeted ranges or full workbook output according to the profile
4. compare critical results with independent fixtures or approved Excel output
5. write calculation diagnostics into the support bundle when results are disputed

Validierungsnachweise

Calculation evidence for finance and support. Keep these fields with the output or support record.

• formula count, dependency graph summary, custom function calls, and recalculation time
• critical cell addresses, formula text, cached value, calculated value, and error state
• custom function version, arguments, returned value, and exception mapping
• locale profile and unsupported-formula warnings

Custom functions need versioned behavior

A formula engine workflow should make dependencies, custom function registration, recalculation mode, cached results, and error handling visible. That is especially important when generated workbooks are consumed without Excel automation.

Implementierungshinweise für die Produktion

Behandle HotXLS: formula calculation and custom functions in Delphi als klaren Servicevertrag rund um die HotXLS-Aufrufe, mit getrennten Schritten für Eingabeprüfung, Arbeitsmappenaufbau, Ausgabekontrolle und Support-Evidenz

• Datenquelle, Zellbereiche und Ausgabeformat festlegen, bevor die Arbeitsmappe erzeugt wird
• Zeilenanzahl, Blattanzahl, Warnungen und Ausgabepfad in ein prüfbares Support-Protokoll schreiben
• Anwendungsspezifische Details in testbare Helper kapseln, statt sie in UI-Ereignissen zu verteilen
• Die gespeicherte Datei erneut öffnen oder prüfen, bevor sie an ein anderes System oder an Kunden geht

Fehlerfälle, die getestet werden sollten

• Ein erfolgreicher SaveAs-Aufruf beweist noch nicht, dass der fachliche Vertrag stimmt
• Schriftarten, Rechte und regionale Einstellungen können auf Servern anders sein als auf Entwicklerrechnern
• Logs dürfen keine Passwörter, Kundendaten oder internen Links offenlegen

Ausführliches Delphi-Beispiel

Das folgende Beispiel zeigt eine praktische Servicegrenze für dieses Thema und hält Policy, Logging und Validierung testbar getrennt

procedure RecalculateInvoiceWorkbook(const TemplateFile, OutputFile: string; const Orders: TArray<TOrderRow>);
var
  Wb: TXLSXWorkbook;
  Sh: IXLSWorksheet;
  RowIndex: Integer;
  Order: TOrderRow;
begin
  Wb := TXLSXWorkbook.Create;
  try
    Wb.Open(TemplateFile);
    RegisterInvoiceFunctions(Wb);
    Sh := Wb.Sheets[0];
    EnsureTemplateVersion(Wb, 'invoice-formulas-v3');

    RowIndex := 2;
    for Order in Orders do
    begin
      Sh.Range['A' + IntToStr(RowIndex)].Value := Order.Sku;
      Sh.Range['B' + IntToStr(RowIndex)].Value := Order.Quantity;
      Sh.Range['C' + IntToStr(RowIndex)].Value := Order.UnitPrice;
      Sh.Range['D' + IntToStr(RowIndex)].Value := '=B' + IntToStr(RowIndex) + '*C' + IntToStr(RowIndex);
      Sh.Range['E' + IntToStr(RowIndex)].Value := '=InvoiceTax(D' + IntToStr(RowIndex) + ')';
      Inc(RowIndex);
    end;

    Wb.Calculate;
    AssertFormulaRangeHasValues(Sh, 'D2:E' + IntToStr(RowIndex - 1));
    WriteCalculationAudit(Wb, 'invoice-formulas', RowIndex - 2);

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

Produktionscheckliste

• 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

Zusätzliche Codebeispiele

procedure TReportBuilder.HandleUserFunction(Sender: TObject;
  const FunctionName: WideString; const Args: Variant;
  var Value: Variant; var Handled: Boolean);
begin
  if SameText(FunctionName, 'DISCOUNT') then
  begin
    Value := Args[0] * 0.9;   // Args arrives as a Variant array
    Handled := True;
  end;
end;

// wiring and use
Book.OnUserFunction := HandleUserFunction;
Sheet.Cells[1, 1].Value := 200;
Sheet.Cells[1, 2].Formula := 'DISCOUNT(A1)';
Net := Book.Calculate('DISCOUNT(A1) + SUM(A1:A1)');

procedure TReportBuilder.HandleUserFunctionEx(Sender: TObject;
  const FunctionName: WideString; const Args: Variant;
  const Context: TXLSUserFunctionContext;
  var Value: Variant; var Handled: Boolean);
begin
  if SameText(FunctionName, 'REGIONRATE') then
  begin
    // the same formula yields a different rate on each regional sheet
    Value := RateForSheet(Context.SheetIndex) * Args[0];
    Handled := True;
  end;
end;

// one array formula spanning A2:A4
Sheet.RCRange[2, 1, 4, 1].SetArrayFormula('A1*{1;2;3}');