DOM API レポートプログラムのテンプレート

DOM API には、レポート生成時のレポートの書式設定用に、各出力タイプに対して既定のテンプレートが付属しています。テンプレートは、レポート内で書式を指定せずに済むよう、既定のデザイン書式を提供するのに役立ちます。多くの組織でよくあることですが、複数のレポートに同じ外観を使用する場合にこの方法が便利です。レポートプログラムでは、名前を通じてテンプレートとそのスタイルおよびレイアウトを参照します。レポートを生成するとき、テンプレートがドキュメントオブジェクトの外観を決定します。

テンプレートを使用すると、フォームベースのドキュメント生成も可能になります。テンプレートには、固定コンテンツとホール (空白) を定義できます。レポートプログラムでは、テキストやイメージなどのコンテンツを使用してこのホールを埋めることができます。フォームベースのレポートを参照してください。

テンプレートを使用するもう 1 つの利点は保守に関するものです。レポートのデザインを変更する場合、変更するのはテンプレートのみで、そのデザインを使用しているすべてのプログラムを変更することにはなりません。

また、テンプレートを使用すると、作成するオブジェクトごとにプロパティを指定する必要がないため、レポートプログラムを小さくできます。数百ページのレポートでは、テンプレートを使用することでパフォーマンスも改善される可能性があります。

既定のテンプレートのコピーを作成し、そのコピーをカスタマイズすることで、レポートの既定の書式設定とレイアウトを指定できます。テンプレートを適用するには、レポートプログラムでテンプレートを参照し、使用するスタイル名とドキュメントパーツを指定しなければなりません。

mlreportgen.dom.Document.createTemplate メソッドを使用して、既定のテンプレートのコピーを作成できます。既定のテンプレートは、テンプレートの開始点としての役割を果たします。

テンプレートパッケージ

単一のファイルの HTML テンプレートを除き、すべての DOM テンプレートは、Open Packaging Conventions (OPC) に基づきパッケージに圧縮されたドキュメント、スタイルシート、およびイメージファイルから構成されます。単一ファイルの HTML テンプレートでは、スタイルシートとイメージが HTML 要素として HTML ドキュメントに組み込まれています。Microsoft^® Word を使用して、(.dotx 拡張子で識別される) Word テンプレートを直接編集できます。任意のテキストエディターまたは HTML エディターを使用して、単一のファイルの HTML テンプレートを直接編集することもできます。

マルチファイル HTML テンプレート (.htmtx 拡張子で識別される) および PDF テンプレート (.pdftx 拡張子で識別される) を編集するには、まずそれらを解凍しなければなりません。必要に応じて、編集した HTML または PDF テンプレートをレポートの生成に使用する前に、テンプレートを再圧縮できます。DOM API には、マルチファイル HTML および PDF のテンプレートを圧縮および解凍する関数 (zipTemplate および unzipTemplate) が用意されています。

スタイル

テンプレートに定義されたスタイルを使用して、段落、テキスト、テーブル、リストなどを書式設定できます。スタイルの変更や独自のスタイルの作成ができます。スタイルシートのスタイルの使用を参照してください。

Word テンプレートには、標準的な Word スタイル (標準、見出し 1、表題など) があります。標準的な Word 手法を使用して、スタイルを作成および変更します。Microsoft Word テンプレートでのスタイルの変更を参照してください。

HTML および PDF テンプレートでは、末尾が .css であるテンプレートファイルの CSS プロパティを使用してスタイルを定義します。詳細については、HTML テンプレートでのスタイルの変更とPDF テンプレートでのスタイルの変更を参照してください。

ページレイアウト

テンプレートを使用して、Word および PDF レポートのサイズ、方向 (縦または横)、余白、ページヘッダー、ページフッターなどのページレイアウトを定義できます。テンプレートを使用して、ドキュメントのさまざまなセクションのさまざまなページレイアウトを定義できます。ページレイアウトセクションの作成を参照してください。

ページレイアウトをプログラムで定義したり、プログラムで定義したレイアウトとテンプレートのレイアウトを組み合わせて使用することもできます。

ドキュメントパーツテンプレート

ドキュメントパーツテンプレートは、レポート内で繰り返すことのできる構造のテンプレートです。DocumentPart オブジェクトを使用すると、ドキュメントパーツのインスタンスをレポートプログラムからレポートに挿入できます。ドキュメントパーツテンプレートライブラリにドキュメントパーツテンプレートを作成します。

Word テンプレートの場合は、ドキュメントパーツテンプレートを定義し、Word のクイックパーツギャラリーに保存します。このクイックパーツギャラリーがライブラリとして機能します。既定のテンプレートにドキュメントパーツテンプレートは含まれません。作成方法については、Microsoft Word のドキュメントパーツテンプレートライブラリの作成を参照してください。

HTML および PDF の場合は、既定のテンプレートに docpart_templates.html という名前のドキュメントパーツテンプレートライブラリファイルが含まれます。このファイルはライブラリを作成するもので、いくつかの既定のドキュメントパーツテンプレートが含まれます。用意されているドキュメントパーツテンプレートの変更や削除および独自のテンプレートの追加ができます。HTML のドキュメントパーツテンプレートライブラリの作成とPDF のドキュメントパーツテンプレートライブラリの作成を参照してください。

参考

unzipTemplate | zipTemplate | mlreportgen.dom.Document.createTemplate