技術記事

DelphiでISO 29500 Strict形式のXLSXファイルを書き出す

アーカイブの取り込み検査が、スプレッドシートをたった1つの指摘で拒否します。xl/workbook.xmlのルート要素がhttp://schemas.openxmlformats.org/spreadsheetml/2006/mainという名前空間に置かれている、という指摘です。まったく同じファイルをExcelは何も言わずに開けます。どちらの結果も正しいのです。ISO/IEC 29500はPart 1でStrict SpreadsheetMLを定義し、レガシー互換機能を伴うTransitional形式をPart 4に保持しています。検証ツールが挙げたURIはTransitional側のものです。ISO 29500 Strictを名指しする入札要件や記録ポリシーは、パッケージのすべてのパートにpurl.oclc.org語彙を期待しており、Excelでは開けるファイルでも、この検査は完全に落ち得ます

StrictとTransitionalで何が変わるのか?

目に見える変化は語彙です。Strictのワークブックパートは、ルート名前空間としてhttp://purl.oclc.org/ooxml/spreadsheetml/mainを、r:id参照にはhttp://purl.oclc.org/ooxml/officeDocument/relationshipsを宣言します。DrawingML、チャート、画像、スプレッドシート描画の各名前空間も同じ方向に移り、文書プロパティのパートも同様です。リレーションシップ型も一緒に変わります。ルートのリレーションシップパートはhttp://purl.oclc.org/ooxml/officeDocument/relationships/officeDocumentを指し、拡張プロパティとカスタムプロパティの型はextendedProperties、customPropertiesとキャメルケースに変わります。Transitionalではハイフン付きで綴られる箇所です

目に見えにくい変化は範囲です。Strictは、レガシーなバイナリ動作を運ぶためだけに存在していたTransitionalスキーマの部分を取り除いており、後からOfficeが追加した拡張のための語彙はまったくありません。この隙間は文字列の検索置換では埋められません。Strictでの書き方そのものが存在しない機能があるからです。したがってパッケージの変換は2つの仕事になります。Strictに相当するものはすべて改名し、相当するものがないものはどう扱うかを決めることです

XLSX パッケージにおける HotXLS StrictOOXML 語彙切替。workbook、relationship、extended-properties パートを openxmlformats transitional 名前空間から purl.oclc.org strict 名前空間へ書き直す
すべてのパートが語彙を一斉に変えます。ルート名前空間からリレーションシップ型、キャメルケースの extendedProperties 型までです。transitional 名前空間はパッケージのどこにも残ってはなりません

DelphiのエクスポートをStrictOOXMLに切り替える

HotXLSでは、切り替えはTXLSXWorkbookの1つのブール型プロパティStrictOOXMLだけで、既定値はFalseです。作成側のコードはこれまでどおりそのままです。シート、セル、数式をいつもどおり構築し、プロパティを設定して保存します。SaveAsは成功すると1を返し、それ以外はパッケージが書き出されなかったことを意味し、理由は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語彙で出力する
    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;

このプロパティは保存の開始時に毎回読み込まれ、ライターが参照する保存単位のスイッチを動かします。途中で失敗した保存が、次の保存にstrict変換を引きずることがありません。1つのワークブックオブジェクトが複数のエクスポート要求に応えるサーバーでは、呼び出しの合間にStrictOOXMLを切り替えられ、各保存は要求されたとおりの語彙を正確に使います

最初に知っておくべき境界が2つあります。Strict出力が対象とするのはOpen XML形式、つまりワークブック、テンプレート、マクロ有効テンプレートです。StrictOOXMLがTrueの状態で.xlsbを要求すると、プロパティを切るように促す診断付きで拒否されます。バイナリ形式にはStrict版が存在しないためです。また、Excelが「Strict Open XML Spreadsheet」として保存したファイルを開いても、プロパティは自動では設定されません。そのようなファイルを読み込み、StrictOOXMLに触れずに保存すると、戻ってくるのはTransitionalパッケージです

strict保存はなぜ実行を拒否するのか?

ワークブックがISO 29500 Strictで表現できないコンテンツを含んでいると、strict保存は実行を拒否します。HotXLSが検査するのは、VBAプロジェクト、ctrlPropsパートを伴うフォームコントロール、スレッド化コメント(旧式のノートではなく現代のpersons/threadsモデル)、スライサー、動的配列メタデータ、塗りつぶし、負のバーの色、カスタム軸などの機能で2009年拡張ブロックに依存するデータバー、そして変換ポリシーが未選択のTimelineです

DelphiにおけるHotXLSのstrict保存ゲート。StrictOOXML付きのSaveAsはVBAプロジェクト、フォームコントロール、スレッド化コメント、スライサー、動的配列メタデータを拒否し、禁止機能が1つもなければ完了する
strict保存はワークブックをISO 29500 Strictで表現できる範囲と照合し、適合を名乗るだけのパッケージを書く代わりに、妨げになる機能を名指しして報告する

ここでは拒否が正しい既定値です。マクロプロジェクトやスライサーを落としたうえで、それでもStrictの印を付けると、問題なく開けるのにエクスポート元とは動きの違うワークブックを誰かに渡すことになります。Excelはそれを決して警告しません。拒否なら、コード側がまだどのレポートを作っていたか把握しているうちに、機能名を教えてくれます。拒否のほとんどはSaveAsが-1を返し、StrictOOXML: Strict output cannot embed VBAのような診断が付く形で届きます。動的配列の保存形式はパッケージの書き出し中に決まるため、このセッションで代入した数式が、メタデータを名指す例外で保存を止めることがあります。StrictのSaveAsは結果の確認に加えてtry..exceptで囲んでください。マクロが必要なワークブックは、VBAプロジェクトと外部リンクの保持で述べるTransitionalの.xlsm経路に進むのが正しい場所です

保存してから知る必要はありません。GetConversionReportは再計算なしにワークブックを検査し、機能名、忠実度レベル、シートインデックス、メッセージを項目に持つTXLSConversionReportを返します。StrictOOXMLの下では、妨げになる項目はxlsConversionUnsupportedとして返ります。Timelineのケースは、意図的にコンテンツを適合性と交換できる唯一の場所でも示しています。StrictTimelineOutputPolicyをxlsxStrictTimelineDateCriteriaに設定すると、対応しているTimelineの選択範囲を標準的なピボット日付基準へ変換し、Timeline UI、そのキャッシュパート、リレーションシップ、定義名を省きます。レポートはこれをxlsConversionDroppedとして列挙し、メモリ上の元のワークブックは変わりません

function StrictBlockers(Wb: TXLSXWorkbook; Log: TStrings): Boolean;
var
  Report: TXLSConversionReport;
  I: Integer;
begin
  Wb.StrictOOXML := True;
  // 文書化済みのTimelineトレードを許容:日付基準は残り、Timeline UIは外れる
  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;

エクスポートの前にこれを実行し、返される行をすべてログに残します。シートインデックスが-1なら、VBAプロジェクトのようなワークブックレベルの項目です。ワークシートの項目は1始まりのシート番号とシート名を運び、Sheetsのインデックス方式と一致します。レポートは、読み込んだワークブックがすでに持っている動的配列メタデータを検出します。コードで代入する数式については、次のセクションのスカラー形式への書き換えに頼ってください

静かに動的配列へ変わる数式

人々を不意打ちにする拒否が、FILTERもSEQUENCEも使ったことのないワークブックでの動的配列メタデータです。Excel 365は複数セル範囲に適用された演算子を、リデューサの中でも配列として評価します。だから=SUM(B2:B4*C2:C4)はExcelの目には配列数式です。このテキストをFormulaに代入すると、HotXLSはExcelと同じく、xl/metadata.xmlへのcm参照を持つ単一セル動的配列としてセルを格納します。そうしないとExcelは読み込み時に暗黙の交差を適用し、#VALUE!を表示してしまいます。背景は配列演算子数式と暗黙の交差にあります。Strictにはこのメタデータパートの語彙がないため、保存は止まります

// 配列形式:2つの範囲の積は配列として評価される
Sh.Cells[5, 2].Formula := '=SUM(B2:B4*C2:C4)';    // strict保存を妨げる

// スカラー形式:素の範囲引数で同じ合計
Sh.Cells[5, 2].Formula := '=SUMPRODUCT(B2:B4,C2:C4)';

Strictエクスポートではスカラー形式で書きます。素の範囲引数のSUMPRODUCTなら同じ合計になり、後でこのファイルを読むものに動的配列対応を要求せず、セルをメタデータパートから完全に外せます。条件付きカウントにも同じ書き換えが使えます。SUMPRODUCT((A2:A4="x")*1)はやはり配列を乗算するので、ここではCOUNTIF(A2:A4,"x")のほうが望ましく、レポートが本当にスピル結果を必要とするなら、Transitional出力が必要です

保持パーツはコピーでなく再構築される

ワークシートのXMLはstrict出力の簡単な部分です。難しいのは、高速なライターなら逐語コピーで済ませたいすべてのパーツです。HotXLSは既存パッケージを開くとき、元のテーマ、接続、外部リンク、チャート、ピボットの各パーツを保持し、Transitional保存ではモデルが変わっていなければ圧縮済みバイト列をそのまま通します。忠実度には正しく、Strictには間違った選択です。そのバイト列には依然としてTransitional名前空間が含まれているからです

StrictOOXMLを有効にすると、これらのパーツすべてでバイトコピー経路は迂回されます。接続、外部リンク、チャートはモデルから再構築し、テーマと取り込んだピボットテーブル、キャッシュ定義、キャッシュレコードのXMLは名前空間トランスレータを通して再生します。このトランスレータは開始タグを1つずつパースし、書き換えるのは名前空間宣言と、.relsパート内のRelationship要素のType属性の2つだけです。セルのテキスト、その他の属性値、コメント、CDATAセクションはバイト単位でそのまま通るため、たまたまhttp://schemas.openxmlformats.org/...を含む共有文字列が書き換わることはありません。schemas.openxmlformats.orgの外にある名前空間URI、たとえばextLstブロック内のMicrosoft拡張名前空間はそのまま残ります。検証ツールがTransitional名前空間に加えて拡張コンテンツも拒否するなら、エクスポート前にそれらの機能を元のワークブックから取り除いてください

保持されるXLSXパーツのHotXLS strict出力経路。テーマ、接続、外部リンク、チャート、ピボットキャッシュは、逐語バイトコピーから、名前空間宣言とリレーションシップ型だけを書き換える再構築または変換再生へ切り替わる
圧縮済みバイト列のコピーはTransitional名前空間をstrictパッケージに持ち込んでしまうため、保持系の経路は高速経路を迂回する。変換が書き換えるのは名前空間宣言とリレーションシップ型だけで、ストリーミングされるワークシートのスケルトンはsheetDataで分割する前に変換される

ストリーミングされるワークシートも同じ規則に従いますが、ひとひねりあります。ライターはまずワークシートのスケルトンを構築して変換し、それから<sheetData>で分割して、間の行をストリーミングします。行ブロックには語彙URIが含まれないため、大きなシートでもStrict出力の追加コストはゼロです。共有文字列とピボットキャッシュレコードも同じ仕組みで、先頭要素だけが変換されます。保持側の詳細はテーマ、拡張リスト、calcChainのロスレス往復変換にあります

Strictファイルの読み込みと書き出し結果の検証

ExcelがStrictとして保存したファイルも、ほかのワークブックと同じように開けます。HotXLSはリレーションシップパートをパースする場所、つまりパッケージのルート、ワークシート、描画、外部リンク、ピボットテーブルのどこでも、Strictのリレーションシップ型をTransitionalの対応物へマッピングし、リーダーはプレフィックスではなく名前空間URIで要素名を解決します。サードパーティの生成ツールはプレフィックスを自由に割り当てるため、同じ仕組みが通常のファイルにも役立ちます。詳細はXLSXパッケージにおけるOPCリレーションシップ解決にあります。そのようなファイルをTransitionalで保存するとき、ルートにまだStrict名前空間を使っている保持XMLパートは書き出しの途中で逆変換されるため、結果が半分だけ別の語彙になることはありません

Strict出力の検証はパッケージに対して行い、どちらの形式も喜んで開けるExcelに対しては決して行わないでください。結果を展開して3つを確認します。xl/workbook.xmlがhttp://purl.oclc.org/ooxml/spreadsheetml/mainを宣言していること、どのパートにもschemas.openxmlformats.org/spreadsheetmlという文字列が含まれていないこと、そして_rels/.relsとxl/_rels/workbook.xml.relsのType値がhttp://purl.oclc.org/ooxml/で始まることです。展開したフォルダーに対するfindstr /s /m "schemas.openxmlformats.org/spreadsheetml" *.xmlの実行結果は、何も列挙しないはずです

次にTXLSXWorkbook.Openでファイルを開き直し、値、数式、表示形式、ハイパーリンクを元のワークブックと比較します。この読み戻しは、同時にリーダー側のマッピングも試します。ワークブックにチャートやピボットテーブルがあれば、それらも比較に含めてください。StrictOOXMLの下では両方ともバイトコピーから再構築または再生の経路に切り替わるからです

Strict出力、Strict対応の読み込み、Transitionalパッケージのロスレス往復変換は、DelphiおよびC++Builder向けHotXLSの1つのOOXMLエンジンで共有されています。対応する形式と機能の一覧はHotXLS Delphiスプレッドシートコンポーネントのページにあります