1 枚のワークシートを完璧に仕上げたとします。見出し帯は結合され、列幅はデータに収まり、上位 2 行は固定され、印刷範囲と余白はきれいな A4 出力のために設定され、タブには財務部門が見つけやすい色が付いています。次に、同じレポートを地域ごとに 12 枚、いずれも同じレイアウトで始まるシートとして用意する必要があります。同じシートをコードで 12 回組み立て直すと、そこに微妙なズレが忍び込みます。地域 7 の列は 1 ポイントだけ狭くなり、地域 11 ではウィンドウ固定が消え、誰も気付かないまま PDF が管理職の机に届くのです。本当に必要なのは、Excel の右クリック「移動またはコピー」「コピーを作成する」をプログラムから実行できる形、つまり完成したシートを元に独立した複製を量産する方法です
HotXLS の XLSX エンジンは、Excel 本体を自動化せずに Excel ファイルを読み書きするネイティブ Delphi / C++Builder ライブラリで、シートの移動、削除、シートをまたぐセル範囲のコピーに対応しており、v2.91.0 からはワークシート全体を 1 回の呼び出しでクローンできるようになりました。その処理を担う入り口は 2 つです。TXLSXWorksheet.CopyFrom はシートレベルの状態を 1 つのワークシートから別のワークシートへコピーし、TXLSXSheets.Duplicate は新しいシートを追加したうえで CopyFrom を実行します。興味深いのは、物をコピーできることそのものではありません。ディープコピーされるものとされないものの間に引かれた明確な線と、その線がまさにそこに引かれている理由にあります
完成したシートを複製する単一の呼び出し
高レベルの操作を実行するのはDuplicateです。コピー元シートの1から始まるインデックスを渡すと、元のレイアウトとデータをミラーリングした新しいワークシートが返されます。インデックスの仕様はXLSX側のItems[]と一致しているため、最初のシートは0ではなく1になります。範囲外のインデックスを渡した場合は、例外が発生するのではなくnilが返されます。これはXLSXの他のシートコレクションと共通の仕様です
var
Book: TXLSXWorkbook;
Template, Copy: TXLSXWorksheet;
begin
Book := TXLSXWorkbook.Create;
try
Template := Book.Sheets.Add('Template');
Template.Cells[1, 1].Value := 'Quarterly Statement';
Template.Range['A1:C1'].Merge;
Template.ColWidth[1] := 18;
Template.FreezePanes(2, 1); // 先頭行と先頭列を固定
Template.TabColorIsAuto := False;
Template.TabColor := $FF1F4E79;
// 明示的な名前で複製...
Copy := Book.Sheets.Duplicate(1, 'Region-North');
// ...あるいは Excel 風の既定名を選ばせる。
Copy := Book.Sheets.Duplicate(1); // -> "Template (2)"
Book.SaveAs('regions.xlsx');
finally
Book.Free;
end;
end;
上記のコードスニペットには、詳しく見ておくべき2つのポイントがあります。第1に、FreezePanesはCells[Row, Col]のインデックス指定と整合するように、行を最初に取るFreezePanes(ARow, ACol)という引数形式を採用しています。複製されたシートは元の固定状態をそのまま継承します。第2に、このメソッドはより一般的なCopyではなくDuplicateと命名されていますが、これは単なる好みの問題ではありません。CopyはSystemユニットの標準ルーチンであり、文字列や動的配列の処理で常に使用されます。クラス内にCopyというメソッドを定義すると、メソッド内での名前解決時に競合(シャドウイング)が発生し、将来的に不具合の原因となります。Duplicateという名称を採用することでこの競合を回避し、呼び出しコードの可読性も維持しています
デフォルトの名前付けはExcelの規則に従う
引数を1つだけ取るオーバーロードを呼び出すか、名前として空文字列を渡すと、新しいシートはコピー元シートの名前に接尾辞(2)を付加した形式で命名され、名前が重複しないように数値が順次インクリメントされます。Templateシートを1回複製するとTemplate (2)になり、もう一度複製するとTemplate (2)がすでに使用されているためTemplate (3)になります。これはExcel自身の「コピーを作成する」コマンドが生成する名前と同じ動作であるため、生成されたワークブックはユーザーにとって極めて自然に見えます。重複チェックは現在アクティブなシートコレクション全体に対して実行されるため、以前の複製処理だけでなく、コードから手動で作成したシート名との重複も自動的に回避されます
地域ごとや月ごとにシートを生成する場合は、名前を明示的に指定するオーバーロードを使用することをお勧めします。(2)や(3)といった接尾辞の並びよりも、予測可能なRegion-NorthやRegion-Southといった名前付けの方が、後のコードから参照しやすく、名前付き定義やシートを跨ぐ数式の可読性も高く保つことができます
CopyFromがディープコピーする項目
内部的には、Duplicateはまず新しいシートを追加した後にCopyFrom(ASource)を呼び出します。すでに作成済みのシートへデータをクローンしたい場合は、CopyFromを直接呼び出すこともできます。CopyFromは、コピー元がnilである場合や、シート自身を自身にコピーしようとする不正なケースを事前にガードします(これらの場合は何もせず即座に復帰します)。それ以外のケースでは、広範囲なデータのコピー処理が実行されます
まずセルのデータがコピーされます。CopyFromはコピー元のUsedRange(データが存在するセルや結合領域を囲む最小のバウンディングボックス)を取得し、既存のCopyRangeToの仕組みを再利用して、すべての値、数式、およびセルごとのスタイルインデックスを複製先シートのA1を起点として転写します。セルのデータに加えて、テンプレートシートの完成度を決定づける以下のシートレベルの状態もすべて複製されます
- 結合セル範囲。座標から再作成されるため、見出し帯は同じ矩形にまたがります
- 列幅と行の高さ。非表示・折りたたみ・アウトラインレベルの各リストも含めてそのままコピーされ、既定と異なる行や列が正確に揃います
- ペインの固定と表示状態。ズーム率、グリッド線とゼロ値の表示、右から左への方向、ビュー種別を含みます
- 保護状態と操作ごとの許可オプション。ロックされたテンプレートは同じ要領でロックされたままになります
- ページ設定ブロック全体。余白、向き、用紙サイズ、拡大縮小とページ数に合わせて印刷、印刷範囲、印刷タイトル、ヘッダーとフッター、印刷グリッド線と印刷見出しの各フラグを含みます
- オートフィルターの範囲、タブの色、シートの表示状態
これにより、コピー元と全く同じように印刷、フィルタリング、および表示が行われるシートが作成されます。また、セル、結合情報、および寸法データは、参照を共有(エイリアス)するのではなく、新しいシート上に物理的に再作成されるため、複製されたシートは完全に独立しています。複製先シートのセルに999を書き込んでも、コピー元シートの元の値は影響を受けません。この独立性は、複数の地域レポートを並行して作成するような用途において最も重要な特性であり、製品に同梱されているデモプログラムSheetCopyでも明確に示されています
シャローコピーにとどまる項目とその理由
この境界線も、同じく意図的なものです。グラフ、埋め込み画像、XLSX テーブル、入力規則、条件付き書式ルールはコピーされません。これは文書化された設計上の決定であり、後から驚かされるのではなく、あらかじめ理由を理解して計画に組み込む価値があります
これらのオブジェクトは、単純なフィールドコピーでは適切に引き継げない固有の識別情報や参照関係を持っています。例えば、グラフは元データのデータ範囲を指し、OOXMLパッケージ内の描画リレーションシップ(描画用の関係定義)を保持しています。リレーションシップや系列の参照先を再マッピングせずにオブジェクトだけをクローンすると、不正なデータを参照するグラフが生成されたり、Excelで「ファイルの修復」が必要とされる壊れたパッケージが生成されたりします。テーブル名もワークブック内で一意である必要があり、ヘッダー行は特定の列に紐付けられ、自動生成される独自のリレーションシップを持っています。条件付き書式や入力規則も座標の範囲と結びついており、入力規則の場合は数式で他の範囲を参照することもあります。これらをすべて正確にディープコピーするには、参照関係の書き換えや識別子の新規発行が必要となり、多くの例外処理が発生します。オブジェクトだけをコピーして参照の修正を行わないような不完全なアプローチをとると、ファイルを開いたときに修復エラーが発生してコンテンツが失われてしまいます。そのため、エンジンは安全にコピーできる要素のみを処理し、参照関係を持つオブジェクトの処理は、最終的にデータが何を指すべきかを知っている開発者(呼び出し側)に委ねています
実際の実装手順としては、まずシートを複製してセル、レイアウト、および印刷設定を生成し、その後、最初に作成した際と同じAPIを使用して、複製先シート上でグラフ、テーブル、入力規則、あるいは条件付き書式を再構築します。複製先シートのデータ範囲に対してこれらを再作成するため、参照関係は自動的に正しく設定されます。例えば、A1:C10のデータを読み取るグラフの場合、複製先シートのA1:C10を指す新しいグラフを追加します。オートフィルターについても、フィルターを適用する範囲データ自体はコピーされるため、列の抽出基準のみを再適用します。条件付き書式や入力規則については、複製されたシートが継承する結合セルや範囲モデルを扱う方法について説明している結合セルとレポートテンプレートのレイアウトに記載されているAPI呼び出しを使用して再適用します
レポート出力ラインにおける複製処理の組み込み
ワークシートの複製は、プレースホルダー駆動型のデータ生成処理と非常に親和性があります。Delphiでのテンプレート駆動型レポート作成ガイドで説明しているトークンアンカー方式は、他者が編集可能なレイアウトへのデータ書き込みの課題を解決します。これに対し、複製処理は、同じレイアウトが1つのワークブック内で何度も必要になるという課題を解決します。これらを組み合わせることで、極めてスマートな実装パターンが完成します。すなわち、トークン、セル結合、および印刷設定を含むオリジナルのTemplateシートを1枚用意しておき、地域や期間ごとにDuplicateを呼び出して複製を作成し、その複製されたシートのトークンにデータを埋め込んでいきます。オリジナルのテンプレートは変更されないため、次のクローンの作成元として常にクリーンな状態に維持され、すべての出力シートが完全に同じレイアウトで作成されます
開発者を混乱させがちな処理順序について注意点があります。シートの複製は、データを流し込む前に実行してください。テンプレートは最後のデータではなく構造とスタイル情報のみを保持するべきであり、データを含まないスタイル付きシートをクローンすることで、各複製をクリーンな状態から開始できます。すでにデータが含まれているシートを複製すると、CopyFromがそのデータ範囲もそのままコピーしてしまいます。特殊な用途でそれを望む場合もありますが、一般的な帳票出力処理では避けるべきです
簡易的な動作確認の習慣
ディープコピーとシャローコピーの境界は、実際に確認するまで分かりにくいため、コピーが正常に行われたことを信用するだけでなく、テストコード等で簡単な整合性チェックを実行する習慣をつけると便利です。複製後に、コピー元シートから継承されたはずの設定情報を読み取って比較確認します
Copy := Book.Sheets.Duplicate(1, 'Region-North');
WriteLn(Format('merged=%d colA=%.1f freezeRow=%d tabAuto=%d',
[Copy.MergedCells.Count, Copy.ColWidth[1],
Copy.FreezeRow, Integer(Copy.TabColorIsAuto)]));
// 独立性の確認:コピーを変更し、元のシートが無傷であることを確認
Copy.Cells[2, 2].Value := 999;
// Template.Cells[2, 2].Value は元の値のまま
結合数、列幅、固定行、タブ色のフラグを確認すれば、コピーされるレイヤーが実際に引き継がれたことを検証できます。あわせて、グラフやテーブル、入力規則、条件付き書式を含んでいたシートの複製では、それらを複製先での「再構築リスト」として扱います。存在しないのは設計どおりであり、再構築は数回の呼び出しで済みます。安全な部分はディープコピー、参照が壊れる部分はシャローコピーというこの思考モデルこそが、この機能を使いこなす要点のすべてです
ここで説明したワークシートの複製機能とCopyFromによるシート状態のコピーは、ネイティブなHotXLS Delphi spreadsheet componentのv2.91.0に実装されています。クローンと書き換えのサイクルをエンドツーエンドで実行するSheetCopyサンプルが付属します