最新のリリースでは、このページがまだ翻訳されていません。 このページの最新版は英語でご覧になれます。

PDF のドキュメント パーツ テンプレート ライブラリの作成

既定のテンプレート パッケージでは、ファイル docpart_templates.html によってライブラリと一部の既定のドキュメント パーツ テンプレートが定義されています。ドキュメント パーツ テンプレート ライブラリで、レポートの各所で再利用するドキュメント パーツを作成します。ドキュメントの繰り返し部分をプログラムで再定義することなく、パーツ テンプレートとして作成できます。

ドキュメント パーツ テンプレートは一般的に固定コンテンツとホールで構成されます。これには、ページ サイズ、余白、方向に加え、ページ ヘッダーとページ フッターを記述するページ レイアウト要素を含めることもできます。PDF のドキュメント パーツ テンプレート ライブラリの作成のために提供された DOM API HTML 要素と HTML 要素のサブセットを使用して、ドキュメント パーツ テンプレート ライブラリを作成します。

次のワークフローを使用して、ドキュメント パーツ テンプレート ライブラリを扱います。

  1. パーツ テンプレート ライブラリ ファイルが含まれるテンプレート パッケージを解凍します。

  2. ドキュメント パーツ テンプレート ファイル (既定の名前は docpart_templates.html) を HTML またはテキスト エディターで開きます。

  3. 必要に応じて、PDF のドキュメント パーツ テンプレート ライブラリの構造で説明されている要素を使用してファイルを編集します。

  4. テンプレート パッケージの .css ファイルに、ドキュメント パッケージ テンプレートをサポートする任意のスタイルを追加します。PDF テンプレートでのスタイルの変更を参照してください。

  5. 編集したライブラリ ファイルを保存します。

  6. ziptemplate を使用して、テンプレートを再パッケージ化します。

PDF のドキュメント パーツ テンプレート ライブラリの構造

<dplibrary> 要素を使用して、ドキュメント パーツ ライブラリを作成します。<dplibrary> 要素を docpart_template.html ファイルの <body> 要素の内部に追加します。テンプレート パッケージでは <dplibrary> 要素を 1 つだけ使用できます。

作成する各ドキュメント パーツ テンプレートの <dplibrary> 要素の内部で <dptemplate> 要素を使用します。必要な数だけドキュメント パーツ テンプレートを作成できます。

次のコードはドキュメント パーツ ライブラリの基本的な構造を示します。<dptemplate> 要素には属性 name があります。この属性は、ドキュメント パーツを呼び出すのに使用する名前に設定します。この名前は、Word のクイック パーツ ギャラリーのパーツの名前と同じです。複数の出力用にテンプレートを作成する場合、両方の場所で同じ名前を使用します。

<body>
    <dplibrary>

        <dptemplate name="myFirstDocPartTemp">
            [Document part template content here--
             holes, fixed content, page layout information, and HTML]
        </dptemplate>

     </dplibrary>
</body>

ドキュメント パーツ テンプレート ライブラリのコンテンツ

DOM API HTML 要素と、標準の HTML 要素のサブセットを使用して、PDF のドキュメント パーツ テンプレートを作成できます。DOM API HTML の使用方法の例については、以下を参照してください。

DOM API HTML 要素

ライブラリとドキュメント パーツの定義に使用する <dplibrary> および <dptemplate> 要素に加え、次の DOM API HTML 要素も PDF テンプレートで使用できます。

目的要素属性
ページ レイアウトlayoutstyle

page-margin: top bottom left right header footer gutter; page-size: height width orientation

first-page-numberレイアウトの最初のページの番号
page-number-format n または N (数値の場合)、aAiI
section-breakこのレイアウトのセクションを開始する場所: Odd PageEven Page または Next Page
ページ ヘッダーpheadertypedefaultfirsteven
template-nameヘッダーを定義するドキュメント パーツ テンプレート
ページ フッターpfootertypedefaultfirsteven
template-nameフッターを定義するドキュメント パーツ テンプレート
ページ番号の形式 (レイアウトの first-page-number および page-number-format と同じ)pnumberformatn または N (数値の場合)、aAiI
initial-valueこの要素を使用するレイアウトの最初のページの番号
ホールholeid名前でホールを識別する ID
default-style-nameスタイルがプログラムで設定されていない場合に使用するスタイル シートのスタイル
目次tocnumber-of-levels目次に含める見出しレベルの数
leader-pattern使用するリーダー パターン: dotsspace、ピリオドまたは空白
自動番号付けautonumberstream-namecounter-increment スタイルで指定されたストリームの名前
現在のページ番号page属性なし 
ドキュメントの総ページ数numpages属性なし 
改ページpagebreak属性なし 
ターゲットが配置されているページへの番号参照pagereftargetターゲットの ID。mlreportgen.dom.LinkTarget を使用してレポート内にターゲットを作成
見出しなどのスタイルのコンテンツをページのヘッダーまたはフッターに挿入 (欄外見出しおよび脚注用)styleref属性なし最も近い h1 要素のコンテンツを挿入
style-nameヘッダーまたはフッターに挿入するコンテンツに使用するスタイルの名前
outline-levelヘッダーまたはフッターに挿入するコンテンツに使用するスタイルのアウトライン レベル
透かしイメージをページ レイアウトに挿入watermarksrc透かしイメージとして使用するソース ファイルのパス。テンプレート パッケージに透かしイメージを保存。PDF ページ レイアウトの透かしを参照してください。
width

透かしイメージをスケーリングする幅 (valueUnits の形式)。有効な単位は、pxincmmmpc、および pt です。

height透かしイメージをスケーリングする高さ (valueUnits の形式)

属性の詳細については、以下の対応する DOM API クラスのプロパティを参照してください。

標準の HTML 要素

PDF テンプレートでは、次の標準の HTML 要素を使用できます。

HTML 要素属性
aclassstylehrefname
bclassstyle
bodyclassstyle
brN/A
codeclassstyle
delclassstyle
divclassstyle
fontclassstylecolorfacesize
h1, h2, h3, h4, h5, h6classstylealign
hrclassstylealign
iclassstyle
insclassstyle
imgclassstylesrcheightwidthalt
liclassstyle
olclassstyle
pclassstylealign
preclassstyle
sclassstyle
spanclassstyle
strikeclassstyle
subclassstyle
supclassstyle
tableclassstylealignbgcolorbordercellspacingcellpaddingframeruleswidth
tbodyclassstylealignvalign
tfootclassstylealignvalign
theadclassstylealignvalign
tdclassstylebgcolorheightwidthcolspanrowspanvalignnowrap
trclassstylebgcolorvalign
ttclassstyle
uclassstyle
ulclassstyle

これらの要素の詳細については、www.w3schools.com/tags の W3Schools タグ ドキュメンテーションを参照してください。

参考

|

関連するトピック