テンプレート-リファレンス


テンプレートファイルでページ情報や各種アイテムを定義することで、任意の帳票をPDFとして出力することができます。
テンプレートファイルだけでもPDFファイルを作成することができますが、固定部をテンプレートファイル、可変部をプログラム(COMやアセンブリ使用)と用途に合わせて組み合わせて利用することで開発効率や保守性を向上させることができます。


テンプレートファイルの書式
キーワード
使用例・記述例



テンプレートファイルの書式


テンプレートファイルはカンマ(,)区切りのテキスト(CSV形式)ファイルです。

ファイル先頭の行には必ずファイル識別子([WFR2016_TEMPLATE])を記述する必要があります。
読み込みは行単位に行われ行先頭のキーワードに従って処理が行われます。

文字データに特殊文字次の特殊文字を含む場合は引用符(")で囲む必要があります。

<特殊文字>
カンマ(,)
ダブルクォーテーション(")
スペース( )
改行コード


ダブルクォーテーション(")を値として扱う場合は2個続けて記述します。
[WFR2016_TEMPLATE]
AddPage,21000,29700
AddItem,"T",0,0,5000,5000,"","","引用符は""です。"


値中に改行を入れ方法は2通りあります。
@ダブルクォーテーション(")で囲み複数行に渡って値を記述する。
[WFR2016_TEMPLATE]
AddPage,21000,29700
AddItem,"T",0,0,5000,5000,"","","今日の天気は雨です。
明日の天気は晴れの予定です。"

AddItem,"T",0,5000,5000,10000,"","","以上"

Aエスケープシーケンス「\n」で改行を記述する。画像アイテムではエスケープシーケンスは使えません。(パス指定に不向きの為)
[WFR2016_TEMPLATE]
AddPage,21000,29700
AddItem,"T",0,0,5000,5000,"","","今日の天気は雨です。\n明日の天気は晴れの予定です。"
AddItem,"T",0,5000,5000,10000,"","","以上"


行先頭にシングルクォーテーション(')を付けることで、その行全てをコメント行とすることができます。
[WFR2016_TEMPLATE]
'A4ページを追加します。
AddPage,21000,29700

'テキストを出力します。
AddItem,"T",0,0,5000,5000,"","","今日の天気は雨です。"
AddItem,"T",0,5000,5000,10000,"","","以上"



キーワード


テンプレートファイルで扱えるキーワード(機能)は次の通りです。

キーワード 説明
[WFR2016_TEMPLATE] ファイル識別子です。
テンプレートファイルの先頭に必ず記述する必要があります。
AddItem アイテムを追加します。
AddPage ページを追加します。
AddStyle スタイルを登録します。



使用例・記述例


テンプレートファイルで請求書のPDFファイルを作成する例です。
下に表示されている画像がこの例にあるテンプレートファイルで作成したPDFファイルです。



請求書を作成するテンプレートファイル(template.txt)の内容


コマンド起動からテンプレートファイルを使いPDFを作成する例


テンプレートファイルを使いPDFを作成する例(COM-VB)


固定部はテンプレートファイル、可変部はプログラムで出力する例(アセンブリ-C#)


固定部はテンプレートファイル、可変部はプログラムで出力する例(ASP.NET-アセンブリ-VB)


このページの先頭へ