<cfhtmltopdfitem> では、<cfhtmltopdf> タグによって作成された PDF ドキュメントのアクション項目を指定します。  type 属性には次の値を指定できます。

  • header
  • footer
  • pagebreak

カテゴリ

データ出力タグ

シンタックス

<cfhtmltopdfitem
type = header/footer/pagebreak
isBase64 = "yes|no"
showonprint = "yes|no"
align = "left|right|center"
marginleft = "number"
marginright = "number"
margintop = "number"
mmarginbottom = "number"
opacity = "number”
numberformat = "LOWERCASEROMAN|NUMERIC|UPPERCASEROMAN"
image = " URL|pathname absolute or relative to web root"
</cfhtmltopdfitem>

属性

属性

必須 / オプション

デフォルト

説明

type、

必須

none

アクションを指定します。

  • header:<cfhtmltopdfitem> タグから </cfhtmltopdfitem> タグまでに指定されたテキストまたはイメージを欄外ヘッダーとして使用します。
  • footer:<cfhtmltopdfitem> タグから </cfhtmltopdfitem> タグまでに指定されたテキストまたはイメージを欄外フッターとして使用します。
  • pagebreak:生成された PDF 内に改ページを挿入するために使用できます。<cfhtmltopdf> がサービスとして使用される場合は、pagebreak は機能しません。
注意:type が header の場合、marginbottom 属性はサポートされません。同様に、type が footer の場合、margintop 属性はサポートされません。

 

isBase64

オプション

 

Yes または No。image 属性に Base64 イメージ文字列が指定される場合にのみ使用します。

showonprint

オプション

 

ドキュメント印刷時のヘッダーまたはフッターの表示、非表示を切り替えます。

align

オプション

Center

テキストの整列方法です。Left、Right または Center を指定します。

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

オプション

 

ヘッダーまたはフッターとして使用するイメージファイルの名前またはオブジェクトです。

次のパラメーターがサポートされます。

  • イメージファイルへのパス
  • Base64 文字列
  • バイト配列
  • <cfimage> オブジェクト

<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 - 総ページ数を追加します。

本作品は Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License によってライセンス許可を受けています。  Twitter™ および Facebook の投稿には、Creative Commons の規約内容は適用されません。

法律上の注意   |   プライバシーポリシー