Creates PDF or FlashPaper output from a text block containing CFML and HTML.

Data Output Tags

cfdocumentitem cfdocumentsection cfform cfpdf cfpdfform cfpresentation cfprint cfreport

ColdFusion 9: Add ppt support to the srcFile attribute. Added the following attributes to support conversion of a Word document to PDF or HTML using OpenOffice libraries:formfields attribute formsType attribute openpassword attribute permissionspassword attribute pdfa attribute tagged attribute ColdFusion 8: Added the following attributes and variables: bookmark attribute localUrl attribute Ability to embed existing PDF forms by using the cfpdfform tag in the cfdocument tag. ColdFusion determines the MIME type of a source file based on the source filename, if the mimeType attribute is not specified. Ability to pass a PDF variable created with the cfdocument tag as the source for the cfpdf tag. authPassword, authUser, proxyHost, proxyPassword, proxyPort, proxyUser, and userAgent attributes saveAsName attribute totalsectionpagecount and currentsectionpagenumber scope variables. ColdFusion MX 7.01: Added the src, srcfile, and mimetype attributes. ColdFusion MX 7: Added this tag.

<cfdocument 
    format = "PDF|FlashPaper" 
    authPassword = "authentication password" 
    authUser = "authentication user name" 
    backgroundVisible = "yes|no" 
    bookmark = "yes|no" 
    encryption = "128-bit|40-bit|none" 
    filename = "filename" 
    fontEmbed = "yes|no" 
    formfields = "yes|no" 
    formsType = "FDF|PDF|HTML|XML" 
    localUrl = "yes|no" 
    marginBottom = "number" 
    marginLeft = "number" 
    marginRight = "number" 
    marginTop = "number" 
    mimeType = "text/plain|application/xml|image/jpeg|image/png|image/bmp|image/gif" 
    name = "output variable name" 
    openpassword = "password to open protected documents" 
    orientation = "portrait|landscape" 
    overwrite = "yes|no" 
    ownerPassword = "password" 
    pageHeight = "page height in inches" 
    pageType = "page type" 
    pageWidth = "page width in inches" 
    pdfa = "yes|no" 
    permissions = "permission list" 
    permissionspassword = "password to access restricted permissions" 
    proxyHost = "IP address or server name for proxy host" 
    proxyPassword = "password for the proxy host" 
    proxyPort = "port of the proxy host" 
    proxyUser = "user name for the proxy host" 
    saveAsName = "PDF filename" 
    scale = "percentage less than 100" 
    src = "URL|pathname relative to web root" 
    srcfile = "absolute pathname to a file" 
    tagged = "yes|no" 
    unit = "in|cm" 
    userAgent = "HTTP user agent identifier" 
    userPassword = "password"> 
        HTML and CFML code 
</cfdocument>

Note: You can specify this tag’s attributes in an attributeCollection attribute whose value is a structure. Specify the structure name in the attributeCollection attribute and use the tag’s attribute names as structure keys.

Use the cfdocument tag to render HTML and CFML output into PDF or FlashPaper format. ColdFusion does not return HTML and CFML outside of the <cfdocument></cfdocument> pair.
The cfdocument tag can render HTML that supports the following standards:
HTML 4.01
XML 1.0
DOM Level 1 and 2
CSS1 and CSS2 (For more information, see the “Supported CSS styles” section).
The cfdocument tag does not support the Internet Explorer-specific HTML generated by Microsoft Word.
Use the following syntax in the filename attribute to specify an in-memory file, which is not written to disk. In-memory files speed processing of transient data.
ram:///filepath The filepath can include directories, for example ram:///petStore/tracking/ordersummary.pdf. Create the directories in the path before you specify the file. For more information on using in-memory files, see Optimizing transient files in the Developing ColdFusion Applications.
You can use the src, srcfile, and mimeType attributes to create PDF or FlashPaper output from a specified file or URL. Use the src and srcfile attributes instead of using the cfhttp tag to display the result in the cfdocument tag. When you specify the src or srcfile attributes, do not include any other content inside the cfdocument tag: ColdFusion ignores the additional content.
The PDF or FlashPaper document returned by the cfdocument tag overwrites any previous HTML in the input stream and ignores any HTML after the </cfdocument> tag.
You cannot embed a cfreport tag in a cfdocument tag.
Note: If you notice that the header text is cropped in the cfdocument tag output, increase the value of the marginTop attribute.

Example 1

<!--- This example creates generates a FlashPaper document. ---> 
<cfdocument format="flashpaper"> 
This is a document rendered by the cfdocument tag.</p> 
 
<table width="50%" border="2" cellspacing="2" cellpadding="2"> 
<tr> 
<td><strong>Name</strong></td> 
<td><strong>Role</strong></td> 
</tr> 
<tr> 
<td>Bill</td> 
<td>Lead</td> 
</tr> 
<tr> 
<td>Susan</td> 
<td>Principal Writer</td> 
</tr> 
<tr> 
<td>Adelaide</td> 
<td>Part Time Senior Writer</td> 
</tr> 
<tr> 
<td>Thomas</td> 
<td>Full Time for 6 months</td> 
</tr> 
<tr> 
<td>Michael</td> 
<td>Full Time for 4 months</td> 
</tr> 
</table> 
</cfdocument>

Example 2

<!--- The following example shows how to use the cfdocument scope variables to generate section numbers and page numbers. ---> 
 
<cfdocument format="pdf"> 
<cfdocumentitem type="header" evalatprint="true"> 
    <table width="100%" border="0" cellpadding="0" cellspacing="0"> 
        <tr><td align="right"><cfoutput>#cfdocument.currentsectionpagenumber# of 
            #cfdocument.totalsectionpagecount#</cfoutput></td></tr> 
    </table> 
</cfdocumentitem> 
 
<cfdocumentitem type="footer" evalatprint="true"> 
    <table width="100%" border="0" cellpadding="0" cellspacing="0"> 
        <tr><td align="center"><cfoutput>#cfdocument.currentpagenumber# of 
            #cfdocument.totalpagecount#</cfoutput></td></tr> 
    </table> 
</cfdocumentitem> 
 
<cfdocumentsection> 
    <h1>Section 1</h1> 
    <cfloop from=1 to=50 index="i"> 
        Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. 
    </cfloop> 
</cfdocumentsection> 
 
<cfdocumentsection> 
    <h1>Section 2</h1> 
    <cfloop from=1 to=50 index="i"> 
        Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. 
    </cfloop> 
</cfdocumentsection> 
 
<cfdocumentsection> 
<h1>Section 3</h1> 
    <cfloop from=1 to=50 index="i"> 
        Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. 
    </cfloop> 
</cfdocumentsection> 
</cfdocument>