Technischer Artikel

ISO-29500-Strict-XLSX-Dateien aus Delphi schreiben

Eine Archiv-Intake-Prüfung weist eine Tabelle mit genau einer Beanstandung zurück: Das Wurzelelement von xl/workbook.xml liegt im Namensraum http://schemas.openxmlformats.org/spreadsheetml/2006/main. Excel öffnet dieselbe Datei anstandslos. Beide Ergebnisse sind korrekt. ISO/IEC 29500 definiert Strict SpreadsheetML in Teil 1 und belässt die transitionale Form mit ihren Legacy-Kompatibilitätsfunktionen in Teil 4, und die URI, die der Validator bemängelt, gehört zu Transitional. Eine Ausschreibung oder Archivierungsrichtlinie, die ISO 29500 Strict nennt, erwartet das purl.oclc.org-Vokabular in jedem Teil des Pakets, und eine Datei kann Excel zufriedenstellen und diesen Test dennoch komplett verfehlen

Was ändert sich zwischen Strict und Transitional?

Der sichtbare Unterschied ist das Vokabular. Ein Strict-Arbeitsmappenteil deklariert http://purl.oclc.org/ooxml/spreadsheetml/main als Wurzel-Namensraum und http://purl.oclc.org/ooxml/officeDocument/relationships für r:id-Verweise. DrawingML-, Chart-, Bild- und Spreadsheet-Drawing-Namensräume ziehen auf dieselbe Weise um, und die Dokumenteigenschaftsteile ebenso. Die Beziehungstypen wechseln mit: Der Wurzel-Beziehungsteil zeigt auf http://purl.oclc.org/ooxml/officeDocument/relationships/officeDocument, und die Typen für erweiterte und benutzerdefinierte Eigenschaften werden camelCase als extendedProperties und customProperties geschrieben, wo Transitional sie mit Bindestrichen schreibt

Der weniger sichtbare Unterschied ist der Umfang. Strict lässt die Teile des transitionalen Schemas weg, die nur existierten, um Legacy-Binärverhalten zu tragen, und es hat überhaupt kein Vokabular für die Erweiterungen, die Office später hinzugefügt hat. Diese Lücke lässt sich nicht mit Suchen-und-Ersetzen über Zeichenketten überdecken, denn manche Funktionen haben schlicht keine strikte Schreibweise. Ein Paket zu konvertieren bedeutet deshalb zwei Aufgaben: alles umzubenennen, was eine Strict-Entsprechung besitzt, und zu entscheiden, was mit dem passiert, das keine besitzt

HotXLS-StrictOOXML-Vokabularwechsel im XLSX-Paket: Workbook-, Relationship- und Extended-Properties-Teile werden von openxmlformats-transitional-Namespaces auf purl.oclc.org-Strict-Namespaces umgeschrieben
Jeder Teil wechselt auf einmal das Vokabular, vom Wurzel-Namensraum über die Beziehungstypen bis zum camelCase-geschriebenen extendedProperties-Typ; kein transitionaler Namensraum darf irgendwo im Paket überleben

Einen Delphi-Export auf StrictOOXML umstellen

In HotXLS ist der Schalter ein einzelner Boolean auf TXLSXWorkbook, StrictOOXML, der standardmäßig auf False steht. Der Erstellungscode bleibt exakt so, wie er ist. Blätter, Zellen und Formeln werden wie gewohnt aufgebaut, die Eigenschaft gesetzt und gespeichert. SaveAs gibt bei Erfolg 1 zurück; alles andere bedeutet, dass das Paket nicht geschrieben wurde, und der Grund steht in Diagnostics

var
  Wb: TXLSXWorkbook;
  Sh: TXLSXWorksheet;
  I: Integer;
begin
  Wb := TXLSXWorkbook.Create;
  try
    Sh := Wb.Sheets.Add('Data');
    Sh.Cells[1, 1].Value := 'Product';
    Sh.Cells[1, 2].Value := 'Amount';
    Sh.Cells[2, 1].Value := 'Widget';
    Sh.Cells[2, 2].Value := 17;
    Sh.Cells[3, 1].Value := 'Gadget';
    Sh.Cells[3, 2].Value := 25;
    Sh.Cells[4, 2].Formula := '=SUM(B2:B3)';

    Wb.StrictOOXML := True;            // ISO/IEC-29500-Strict-Vokabular
    if Wb.SaveAs('archive-copy.xlsx') <> 1 then
    begin
      for I := 0 to Wb.Diagnostics.Count - 1 do
        WriteLn(Wb.Diagnostics[I].Message);
      raise Exception.Create('Strict save was refused');
    end;
  finally
    Wb.Free;
  end;
end;

Die Eigenschaft wird zu Beginn jedes Speichervorgangs gelesen und steuert einen speicherweisen Schalter, den die Writer abfragen, sodass ein Speichervorgang, der auf halbem Weg scheitert, die strikte Übersetzung nicht in den nächsten hinein eingeschaltet lassen kann. Auf einem Server, auf dem ein einzelnes Workbook-Objekt mehrere Exportanfragen beantwortet, lässt sich StrictOOXML zwischen den Aufrufen umschalten, und jeder Speichervorgang bekommt exakt das Vokabular, das er angefordert hat

Zwei Grenzen sollte man vorab kennen. Strikte Ausgabe gilt für die Open-XML-Formate: Arbeitsmappe, Vorlage und makrofähige Vorlage. Die Anfrage für .xlsb, während StrictOOXML auf True steht, wird mit einem Diagnostic zurückgewiesen, der auffordert, die Eigenschaft auszuschalten, denn das Binärformat hat keine Strict-Variante. Und das Öffnen einer Datei, die Excel als "Strict Open XML Spreadsheet" gespeichert hat, setzt die Eigenschaft nicht von selbst. Eine solche Datei laden, speichern, ohne StrictOOXML anzufassen, und heraus kommt wieder ein transitionales Paket

Warum kann ein striktes Speichern die Ausführung verweigern?

Ein striktes Speichern verweigert die Ausführung, wenn die Arbeitsmappe Inhalt enthält, den ISO 29500 Strict nicht ausdrücken kann. Die Familien, die HotXLS prüft, sind VBA-Projekte, Formular-Controls mit ihren ctrlProps-Teilen, Thread-Kommentare (das moderne Personen-und-Threads-Modell, nicht klassische Notizen), Slicer, Dynamic-Array-Metadaten, Datenbalken, die für Funktionen wie Volltonfüllung, negative Balkenfarben oder eine eigene Achse auf den Erweiterungsblock von 2009 angewiesen sind, und Timelines, solange keine Konvertierungsrichtlinie gewählt wurde

HotXLS-Strict-Save-Tor in Delphi: SaveAs mit StrictOOXML verweigert VBA-Projekte, Formular-Controls, Thread-Kommentare, Slicer und Dynamic-Array-Metadaten und vollendet nur, wenn kein verbotenes Feature vorhanden ist
Ein striktes Speichern prüft die Arbeitsmappe gegen das, was ISO 29500 Strict ausdrücken kann, und benennt jedes blockierende Feature, statt ein Paket zu schreiben, das nur Konformität behauptet

Verweigern ist hier die richtige Voreinstellung. Die Alternative wäre, das Makroprojekt oder die Slicer still fallen zu lassen und das Ergebnis trotzdem als Strict zu stempeln. Das liefert jemandem eine Arbeitsmappe, die sich sauber öffnen lässt und sich anders verhält als die, die exportiert wurde. Excel würde das niemals anmarken. Eine Verweigerung benennt das Feature, während der eigene Code noch weiß, welcher Bericht da entstehen sollte. Die meisten Verweigerungen zeigen sich als SaveAs, das -1 zurückgibt, mit einem Diagnostic wie StrictOOXML: Strict output cannot embed VBA. Die Dynamic-Array-Speicherung wird entschieden, während das Paket geschrieben wird, daher kann eine in dieser Sitzung zugewiesene Formel das Speichern noch mit einer Exception stoppen, die die Metadaten benennt; ein striktes SaveAs kommt also auch in try..except, zusätzlich zur Prüfung des Ergebnisses. Braucht die Arbeitsmappe ihre Makros, gehört sie auf den transitionalen .xlsm-Pfad, der in Erhalt von VBA-Projekten und externen Verknüpfungen beschrieben wird

Das muss man nicht erst beim Speichern herausfinden. GetConversionReport inspiziert die Arbeitsmappe, ohne sie neu zu berechnen, und liefert einen TXLSConversionReport, dessen Einträge einen Featurenamen, eine Fidelity-Stufe, einen Blattindex und eine Meldung tragen. Unter StrictOOXML kommen die blockierenden Einträge als xlsConversionUnsupported zurück. Der Timeline-Fall zeigt auch die eine Stelle, an der man auf Wunsch Inhalt gegen Konformität tauschen kann: Setzt man StrictTimelineOutputPolicy auf xlsxStrictTimelineDateCriteria, verwandelt das unterstützte Timeline-Auswahlen in Standard-Pivot-Date-Kriterien und lässt die Timeline-UI samt ihrer Cache-Teile, Beziehungen und definierten Namen weg. Der Report führt das als xlsConversionDropped, und die Quell-Arbeitsmappe im Speicher bleibt unverändert

function StrictBlockers(Wb: TXLSXWorkbook; Log: TStrings): Boolean;
var
  Report: TXLSConversionReport;
  I: Integer;
begin
  Wb.StrictOOXML := True;
  // Den dokumentierten Timeline-Trade akzeptieren: die Date-Kriterien bleiben, die Timeline-UI fliegt
  Wb.StrictTimelineOutputPolicy := xlsxStrictTimelineDateCriteria;
  Report := Wb.GetConversionReport(xlsConversionOpenXmlWorkbook);
  try
    Result := False;
    for I := 0 to Report.Count - 1 do
      if Report[I].Fidelity in [xlsConversionUnsupported, xlsConversionDropped] then
      begin
        Log.Add(Format('%s (sheet %d): %s',
          [Report[I].Feature, Report[I].SheetIndex, Report[I].Message]));
        if Report[I].Fidelity = xlsConversionUnsupported then
          Result := True;
      end;
  finally
    Report.Free;
  end;
end;

Diese Funktion vor dem Export ausführen und jede zurückgegebene Zeile mitloggen. Ein Blattindex von -1 markiert einen Eintrag auf Arbeitsmappenebene wie das VBA-Projekt; Worksheet-Einträge tragen die 1-basierte Blattnummer und den Blattnamen, passend zur Indizierung von Sheets. Der Report sieht auch Dynamic-Array-Metadaten, die eine geladene Arbeitsmappe bereits mitbringt; für Formeln, die im Code zugewiesen werden, verlässt man sich auf die skalare Umschreibung im nächsten Abschnitt

Die Formel, die still zu einem Dynamic Array wird

Die Verweigerung, die jeden unerwartet erwischt, sind Dynamic-Array-Metadaten in einer Arbeitsmappe, die nie FILTER oder SEQUENCE benutzt hat. Excel 365 wertet einen Operator auf einem Mehrzellbereich als Array aus, sogar innerhalb eines Reducers, deshalb ist =SUM(B2:B4*C2:C4) in Excels Augen eine Array-Formel. Weist man diesen Text Formula zu, speichert HotXLS die Zelle so, wie Excel es täte: als Dynamic Array mit einer Zelle und einem cm-Verweis in xl/metadata.xml; andernfalls würde Excel beim Laden implizite Schnittmenge anwenden und #VALUE! zeigen. Den Hintergrund liefert Array-Operator-Formeln und implizite Schnittmenge. Strict hat kein Vokabular für diesen Metadatenteil, also stoppt das Speichern

// Array-Speicherung: das Produkt zweier Bereiche wird als Array ausgewertet
Sh.Cells[5, 2].Formula := '=SUM(B2:B4*C2:C4)';    // blockiert ein striktes Speichern

// Skalare Speicherung: schlichte Bereichsargumente, dieselbe Summe
Sh.Cells[5, 2].Formula := '=SUMPRODUCT(B2:B4,C2:C4)';

Für Strict-Exporte die skalare Form schreiben. SUMPRODUCT mit schlichten Bereichsargumenten liefert dieselbe Summe, braucht in allem, was die Datei später liest, keine Dynamic-Array-Unterstützung und hält die Zelle komplett aus dem Metadatenteil heraus. Dieselbe Umschreibung funktioniert bei bedingten Zählungen: SUMPRODUCT((A2:A4="x")*1) multipliziert weiterhin Arrays, deshalb dort lieber COUNTIF(A2:A4,"x"). Braucht ein Bericht wirklich ausgeschüttete Ergebnisse, braucht er transitionale Ausgabe

Erhaltene Teile werden neu aufgebaut statt kopiert

Die Worksheet-XML ist der einfache Teil strikter Ausgabe. Der schwierige Teil ist alles, was ein schneller Writer lieber wortgetreu kopieren würde. Öffnet HotXLS ein vorhandenes Paket, behält es das originale Theme, Verbindungen, externe Verknüpfungen, Diagramme und Pivot-Teile, und bei einem translationalen Speichern reicht es deren komprimierte Bytes unverändert durch, solange sich das Modell nicht geändert hat. Für die Originaltreue genau richtig, für Strict genau falsch, denn diese Bytes tragen weiterhin transitionale Namensräume

Mit StrictOOXML wird der Byte-Kopierpfad für all diese Teile umgangen. Verbindungen, externe Verknüpfungen und Diagramme werden aus dem Modell neu aufgebaut; das Theme sowie die erfasste Pivot-Table-, Cache-Definitions- und Cache-Record-XML laufen durch den Namensraum-Übersetzer. Der parst jedes Start-Tag und schreibt nur zwei Dinge um: Namensraum-Deklarationen und das Type-Attribut von Relationship-Elementen in .rels-Teilen. Zelltext, andere Attributwerte, Kommentare und CDATA-Abschnitte gehen Byte für Byte durch, sodass ein Shared String, der zufällig http://schemas.openxmlformats.org/... enthält, niemals angefasst wird. Namensraum-URIs außerhalb von schemas.openxmlformats.org, etwa die Microsoft-Erweiterungs-Namensräume innerhalb von extLst-Blöcken, bleiben, wie sie sind; lehnt der eigene Validator auch Erweiterungsinhalte ab und nicht nur transitionale Namensräume, entfernt man diese Funktionen vor dem Export aus der Quell-Arbeitsmappe

HotXLS-Strict-Ausgabepfad für erhaltene XLSX-Teile: Theme, Connections, externe Links, Diagramme und Pivot-Caches wechseln von wörtlicher Byte-Kopie zu Neuaufbau oder einer übersetzenden Wiedergabe, die nur Namensraum-Deklarationen und Beziehungstypen umschreibt
Kopierte komprimierte Bytes würden transitionale Namensräume ins strikte Paket schmuggeln, daher umgehen die erhaltenen Pfade den schnellen Weg; die Übersetzung schreibt nur Namensraum-Deklarationen und Beziehungstypen um, und das gestreamte Worksheet-Skelett wird übersetzt, bevor es an sheetData aufgeteilt wird

Gestreamte Worksheets folgen derselben Regel mit einer Wendung. Der Writer baut zuerst das Worksheet-Skelett, übersetzt es und teilt es erst danach an <sheetData> auf, um die Zeilen dazwischen zu streamen. Zeilenblöcke enthalten keine Vokabular-URIs, also zahlen große Blätter für strikte Ausgabe nichts extra. Shared Strings und Pivot-Cache-Records funktionieren genauso: Nur das Header-Element wird übersetzt. Mehr zur Erhaltungsseite steht in verlustfreie Round-Trips von Themes, Erweiterungslisten und calcChain

Strict-Dateien lesen und prüfen, was man geschrieben hat

Dateien, die Excel als Strict gespeichert hat, öffnen sich wie jede andere Arbeitsmappe. HotXLS mappt Strict-Beziehungstypen auf ihre Transitional-Pendants, wo immer ein Beziehungsteil geparst wird: an der Paketwurzel, in Worksheets, Drawings, externen Verknüpfungen und Pivot-Tabellen, und der Reader löst Elementnamen über die Namensraum-URI statt über das Präfix auf. Drittanbieter-Generatoren vergeben Präfixe frei, deshalb dient dieselbe Mechanik auch gewöhnlichen Dateien; beschrieben wird sie in OPC-Beziehungsauflösung in XLSX-Paketen. Bei einem translationalen Speichern einer solchen Datei wird jeder erhaltene XML-Teil, dessen Wurzel weiterhin einen Strict-Namensraum verwendet, auf dem Weg hinaus zurückkonvertiert, damit das Ergebnis nicht halb in dem einen Vokabular und halb in dem anderen endet

Strikte Ausgabe am Paket prüfen, nie an Excel, das beide Formen anstandslos öffnet. Das Ergebnis entpacken und drei Dinge kontrollieren: xl/workbook.xml deklariert http://purl.oclc.org/ooxml/spreadsheetml/main, kein Teil enthält die Zeichenkette schemas.openxmlformats.org/spreadsheetml, und die Type-Werte in _rels/.rels und xl/_rels/workbook.xml.rels beginnen mit http://purl.oclc.org/ooxml/. Ein kurzer Lauf von findstr /s /m "schemas.openxmlformats.org/spreadsheetml" *.xml über den entpackten Ordner sollte nichts auflisten

Dann die Datei über TXLSXWorkbook.Open erneut öffnen und Werte, Formeln, Zahlenformate und Hyperlinks mit der Quell-Arbeitsmappe vergleichen. Dieser Rücklesetest übt nebenbei das Mapping auf der Leserseite. Trägt die Arbeitsmappe Diagramme oder Pivot-Tabellen, gehören sie in den Vergleich, denn beide wechseln unter StrictOOXML von der Byte-Kopie auf einen neu aufgebauten oder wiedergegebenen Pfad

Strikte Ausgabe, tolerantes Lesen von Strict-Dateien und verlustfreie Round-Trips durch transitionale Pakete laufen in HotXLS für Delphi und C++Builder auf einer gemeinsamen OOXML-Engine; die HotXLS-Delphi-Tabellenkalkulationskomponentenseite listet die Formate und Funktionen, die sie abdeckt