CFDOCUMENT  
説明

CFML および HTML を含むテキストブロックから PDF または FlashPaper 形式の出力を作成します。

 
カテゴリ

データ出力タグ

 
シンタックス
<cfdocument
   format = "PDF"、"FlashPaper"
   filename = "filename"
   overwrite = "yes"、"no"
   name = "output variable name"
   pagetype = "page type"
   pageheight = "page height in inches"
   pagewidth = "page width in inches"
   orientation = "portrait/landscape"
   margintop = "number"
   marginbottom = "number"
   marginleft = "number"
   marginright = "number"
   unit = "in"、"cm"
   encryption = "128-bit"、"40-bit"、"none"
   ownerpassword = "password"
   userpassword = "password"
   permissions = "permission list"
   fontembed = "yes"、"no"
   backgroundvisible = "yes"、"no"
   scale = "percentage less than 100">

   HTML および CFML コード
</cfdocument>
 
関連項目

cfreport、cfdocumentitem、cfdocumentsection

 
ヒストリ

ColdFusion MX 7: このタグが追加されました。

 
使用方法

cfdocument タグを使用して、HTML および CFML の出力を PDF または FlashPaper 形式で表示します。ColdFusion MX は、HTML と CFML を <cfdocument> </cfdocument> ペアの外側には返しません。

cfdocument タグでは、次の標準をサポートする HTML を表示できます。

  • HTML 4.01
  • XML 1.0
  • DOM Level 1 および 2
  • CSS1 および CSS2

cfdocument タグは、Microsoft Word で生成された Internet Explorer 固有の HTML をサポートしません。

cfdocument タグで返された PDF または FlashPaper 形式のドキュメントにより、入力ストリーム内の既存の HTML は上書きされ、</cfdocument> タグの後の HTML は無視されます。

cfreport タグを cfdocument タグに埋め込むことはできません。

cfdocument タグを使用するときに、ColdFusion MX は cfdocument という名前の新しいスコープを作成します。このスコープには、次の変数が含まれています。

  • currentpagenumber
  • totalpagecount
メモ: cfdocument スコープ変数は、ページ番号の表示のために予約されています。これらを ColdFusion の式で使用しないでください。たとえば、次のようなコードは機能しません。
<cfif cfdocument.currentpagenumber gt 1>
   <cfoutput>#cfdocument.currentpagenumber-1#</cfoutput>
</cfif>
 
<cfdocument format="flashpaper">
<p>これは、cfdocument tag によって表示されるドキュメントです。</p>

<table width="50%" border="2" cellspacing="2" cellpadding="2">
  <tr>
    <td><strong>名前</strong></td>
    <td><strong>ロール</strong></td>
  </tr>
  <tr>
    <td>Bill</td>
    <td>リード</td>
  </tr>
  <tr>
    <td>Susan</td>
    <td>主任ライター</td>
  </tr>
  <tr>
    <td>Adelaide</td>
    <td>パートタイムのシニアライター</td>
  </tr>
  <tr>
    <td>Thomas</td>
    <td>6 か月フルタイム</td>
  </tr>
  <tr>
    <td>Michael</td>
    <td>4 か月フルタイム</td>
  </tr>
</table>
</cfdocument> 
FORMAT  
  必須
 

レポートの形式を指定します。

  • PDF
  • FlashPaper
FILENAME  
  オプション
 

PDF または FlashPaper 形式の出力を含むファイルの名前を指定します。

filename 属性を省略すると、ColdFusion MX は出力をブラウザに送ります。

OVERWRITE  
  オプション
 
Default value: "no"

ColdFusion MX で既存のファイルを上書きするかどうかを指定します。filename 属性と共に使用します。

NAME  
  オプション
 

タグが PDF 出力または FlashPaper 出力を保管する保管先の既存変数名を指定します。

PAGETYPE  
  オプション
 
Default value: "A4"

ColdFusion で生成するレポートのページサイズを指定します。

  • legal: 8.5 インチ x 14 インチ
  • letter: 8.5 インチ x 11 インチ
  • A4: 8.27 インチ x 11.69 インチ
  • A5: 5.81 インチ x 8.25 インチ
  • B5: 9.81 インチ x 13.88 インチ
  • Custom: カスタムの高さと幅です。カスタムを指定する場合は、pageheight 属性と pagewidth 属性も指定する必要があります。必要に応じて、マージンに関する属性の指定や、単位をインチまたはセンチメートルのいずれにするかの指定もできます。
PAGEHEIGHT  
  オプション
 

ページの高さをインチ (デフォルト) またはセンチメートルを単位として指定します。この属性は、pagetype=custom の場合にのみ有効です。ページの高さをセンチメートル単位で指定するには、unit=cm 属性を使用します。

PAGEWIDTH  
  オプション
 

ページの幅をインチ (デフォルト) またはセンチメートルを単位として指定します。この属性は、pagetype=custom の場合にのみ有効です。ページの幅をセンチメートル単位で指定するには、unit=cm 属性を使用します。

ORIENTATION  
  オプション
 
Default value: "portrait"

ページの向きを指定します。

  • portrait
  • landscape
MARGINTOP  
  オプション
 

ページの上マージンをインチ (デフォルト) またはセンチメートルを単位として指定します。上マージンをセンチメートル単位で指定するには、unit=cm 属性を使用します。

MARGINBOTTOM  
  オプション
 

ページの下マージンをインチ (デフォルト) またはセンチメートルを単位として指定します。下マージンをセンチメートル単位で指定するには、unit=cm 属性を使用します。

MARGINLEFT  
  オプション
 

ページの左マージンをインチ (デフォルト) またはセンチメートルを単位として指定します。左マージンをセンチメートル単位で指定するには、unit=cm 属性を使用します。

MARGINRIGHT  
  オプション
 

ページの右マージンをインチ (デフォルト) またはセンチメートルを単位として指定します。右マージンをセンチメートル単位で指定するには、unit=cm 属性を使用します。

UNIT  
  オプション
 
Default value: "in"

pageheight、pagewidth、および margin の各属性で使用するデフォルトの単位を指定します。

  • in: インチです。
  • cm: センチメートルです。
ENCRYPTION  
  オプション
 
Default value: "none"

(format="PDF" の場合のみ) 出力を暗号化するかどうかを指定します。

  • 128-bit
  • 40-bit
  • none
OWNERPASSWORD  
  オプション
 

(format="PDF" の場合のみ) 所有者のパスワードを指定します。

USERPASSWORD  
  オプション
 

(format="PDF" の場合のみ) ユーザーのパスワードを指定します。

PERMISSIONS  
  オプション
 

(format="PDF" の場合のみ) 次のアクセス許可から 1 つ以上を指定します。

  • AllowPrinting
  • AllowModifyContents
  • AllowCopy
  • AllowModifyAnnotations
  • AllowFillIn
  • AllowScreenReaders
  • AllowAssembly
  • AllowDegradedPrinting

複数のアクセス許可を指定する場合は、カンマで区切ります。

FONTEMBED  
  オプション
 
Default value: "yes"

ColdFusion が出力にフォントを埋め込むかどうかを指定します。

  • yes: フォントを埋め込みます。
  • no: フォントを埋め込みません。

Selective: Java フォントとコアフォント以外のすべてのフォントを埋め込みます。詳細については、「使用方法」を参照してください。

BACKGROUNDVISIBLE  
  オプション
 
Default value: "no"

ドキュメントの出力時に背景を出力するかどうかを指定します。

  • yes: 出力時に背景を含めます。
  • no: 出力時に背景を含めません。
SCALE  
  オプション
 
Default value: "ColdFusion が計算する値"

スケール係数をパーセントで指定します。このオプションを使用して HTML 出力のサイズを縮小し、用紙のサイズに合うようにします。100 未満の数値を指定します。