例
<cfhtmltopdf destination="myPDF.pdf" source="http://somesite.com" overwrite="true">
<cfhtmltopdfitem type="header">
Page: _PAGENUMBER of _LASTPAGENUMBER
</cfhtmltopdfitem>
<cfhtmltopdfitem type="pagebreak" />
<cfhtmltopdfitem type="footer" image="test.jpg">
</cfhtmltopdfitem>
</cfhtmltopdf>
このタグがタグの本文でサポートする HTML は非常に限られています。 <body>、<p>、<i>、<b>、<span> という 5 つの HTML タグのみをサポートします。
サポートされる HTML の完全なリファレンスについては、こちらを参照してください。
<cfhtmltopdfitem> の内容では、次のスコープ変数にアクセスできます。
- _PAGENUMBER – 現在のページ番号を追加します。
- _LASTPAGENUMBER – 最終ページ番号を追加します。
_CURRENTPAGENUMBER – 現在のページ番号を追加します。
- _TOTALPAGECOUNT - 総ページ数を追加します。
- CFHTMLTOPDF.currentPageNumber – 現在のページ番号を追加します。
- CFHTMLTOPDF.totalPageCount – 総ページ数を追加します。
<cfhtmltopdfitem> では、<cfhtmltopdf> タグによって作成された PDF ドキュメントのアクション項目を指定します。 type 属性には次の値を指定できます。
- ヘッダーの提供
- footer
- pagebreak
カテゴリ
データ出力タグ
シンタックス
<cfhtmltopdfitem> type = header/footer/pagebreak isBase64 = "yes|no" showonprint = "yes|no" align = "left|right|center" evalAtPrint = "true|false" marginleft = "数値" marginright = "数値" margintop = "数値" marginbottom = "数値" opacity = "数値” numberformat = "LOWERCASEROMAN|NUMERIC|UPPERCASEROMAN" image = " URL|web ルートへの絶対パスまたは相対パス" </cfhtmltopdfitem>
履歴
- ColdFusion（2016 リリース）アップデート 3： - evalAtPrint 属性を追加しました。
- ColdFusion（2016 リリース） - CFHTMLTOPDF.currentPageNumber および CFHTMLTOPDF.totalPageCount スコープ変数を追加しました。
- ColdFusion 11 更新プログラム 3 - _CURRENTPAGENUMBER およよび _TOTALPAGECOUNT スコープ変数を追加しました。
属性
属性 |
必須／オプション |
デフォルト |
説明 |
|---|---|---|---|
type |
必須 |
なし |
アクションを指定します。
メモ：type が "header" の場合、marginbottom 属性はサポートされません。同様に、type が "footer" の場合、margintop 属性はサポートされません。 |
isBase64 |
オプション |
|
Yes または No。image 属性に Base64 イメージ文字列が指定される場合にのみ使用します。 |
showonprint |
オプション |
|
ドキュメント印刷時のヘッダーまたはフッターの表示、非表示を切り替えます。 |
align |
オプション |
Center |
テキストの整列方法です。Left、Right または Center を指定します。 |
evalAtPrint |
オプション |
false |
このプロパティを true に設定した場合、その PDF が生成された後に cfhtmltopdfitem の内容が評価され、各ページでページ番号を使用できるようになります。これにより、cfhtmltopdfitem 内でいくつかの条件コードを使用できます。 メモ：evalAtPrint=true の場合、numberformat 属性を numeric に設定する必要があります。 |
marginleft |
オプション |
1.0 |
ページの左マージンをインチ（デフォルト）またはセンチメートル単位で指定します。左マージンをセンチメートル単位で指定するには、unit=cm 属性を使用します。 |
marginright |
オプション |
1.0 |
ページの右マージンをインチ（デフォルト）またはセンチメートル単位で指定します。左マージンをセンチメートル単位で指定するには、unit=cm 属性を使用します。 |
margintop |
オプション |
0.5 |
ページの上マージンをインチ（デフォルト）またはセンチメートル単位で指定します。左マージンをセンチメートル単位で指定するには、unit=cm 属性を使用します。 |
marginbottom |
オプション |
0.5 |
ページの下マージンをインチ（デフォルト）またはセンチメートル単位で指定します。下マージンをセンチメートル単位で指定するには、unit=cm 属性を使用します。 |
opacity |
オプション |
10 |
ヘッダーまたはフッターの不透明度です。有効な数値を指定します。1 ～ 10 の数値です。 |
numberformat |
オプション |
Numeric |
使用するページ番号形式です（LOWERCASEROMAN|NUMERIC|UPPERCASEROMAN）。 |
image |
オプション |
|
ヘッダーまたはフッターとして使用するイメージファイルの名前またはオブジェクトです。 次のパラメーターがサポートされます。
|
