<cfdocument>

Creates a PDF document from a text block containing CFML and HTML.

Note that Word and Excel conversion is not available.

This tag may have a body.

This tag is also supported within <cfscript>

Requires Extension: PDF Extension for Jakarta EE (Lucee 7+)


		<cfdocument
    backgroundvisible=boolean
    encryption=String
    filename=String
    fontembed=string
    fontdirectory=string
    format=string
    page=any
    margin=any
    marginbottom=number
    marginleft=number
    marginright=number
    margintop=number
    mimetype=string
    name=string
    orientation=string
    overwrite=boolean
    ownerpassword=string
    pageheight=number
    pagewidth=number
    pagetype=string
    permissions=string
    scale=number
    src=string
    srcfile=string
    type=string
    unit=string
    userpassword=string
    proxyHost=string
    proxyPort=number
    proxyUser=string
    proxyPassword=string
    bookmark=boolean
    htmlbookmark=boolean
    localUrl=boolean
    authUser=string
    authPassword=string
    userAgent=string
    saveAsName=string
><!--- body --->[</cfdocument>]

Attribute	Description
encryption _{String, optional}	edit define if the output should be encrypted and how deep
filename _{String, optional}	edit name for output file, if not defined output will be written to response stream
fontembed _{string, optional}	edit define if fonts will embedded with the file
fontdirectory _{string, optional}	edit directory that contains additional font files (.ttf) and a pd4fonts.properties to describe them. Note: Classic engine works using the font-family-name from pd4fonts.properties file. Modern (Flying saucer) engine works using the font-family-name from the .ttf file with the same case.
format _{string, optional}	edit format of the created file
page _{any, optional}	edit Specifies the page info in a struct like this {width:10, height:5, type:A4}
margin _{any, optional}	edit Specifies the margin in inches (default), centimeters or points. The attribute unit controls the type. possible values is a number, so margin is the same all around, or a struct like this {top:1,bottom:1,left:2,right:2}
marginbottom _{number, optional}	edit Specifies the bottom margin in inches (default) or centimeters. To specify bottom margin in centimeters, include the unit=cm attribute.
marginleft _{number, optional}	edit Specifies the left margin in inches (default) or centimeters. To specify left margin in centimeters, include the unit=cm attribute.
marginright _{number, optional}	edit Specifies the right margin in inches (default) or centimeters. To specify right margin in centimeters, include the unit=cm attribute.
margintop _{number, optional}	edit Specifies the top margin in inches (default) or centimeters. To specify top margin in centimeters, include the unit=cm attribute.
mimetype _{string, optional}	edit mimetype of the source (when attribute src or srcfile are defined)
name _{string, optional}	edit name of a variable to store the output in it _{Alias: variable}
orientation _{string, optional}	edit Page orientation. Can be "landscape" or "portrait". Defaults to "portrait".
overwrite _{boolean, optional}	edit define if an existing file will be overwritten or not
ownerpassword _{string, optional}	edit Specifies an owner password (format="PDF" only).
pageheight _{number, optional}	edit used when pagetype is custom
pagewidth _{number, optional}	edit used when pagetype is custom
pagetype _{string, optional}	edit defined the used format for the page (,legal,letter,A4,A5,B4,B5,B4-JIS,B5-JIS and custom)
permissions _{string, optional}	edit Sets the permissions for the document AllowPrinting AllowModifyContents AllowCopy AllowModifyAnnotations AllowFillIn AllowScreenReaders AllowAssembly AllowDegradedPrinting
src _{string, optional}	edit define a url or a relative path on the local system to a file that should be transferred to a pdf
srcfile _{string, optional}	edit define an absolute path to a file that should be transferred to a pdf
type _{string, optional}	edit Specifies which engine should be used to render the document. Options are: classic modern (Available since PDF Extension version 1.0.0.92) Defaults to the Application's `this.pdf.type` setting (which defaults to "modern").
unit _{string, optional}	edit set the unit for pageheight, pagewidth, and margin...
userpassword _{string, optional}	edit Specifies a user password (format="PDF" only). Defaults to "empty" if is not set, and encryption is set to 40 bit or 128 bit.
proxyHost _{string, optional}	edit alias for proxyHost _{Alias: proxyserver}
proxyPort _{number, optional}	edit The port number on the proxy server from which the object is requested. Default is 80. When used with resolveURL, the URLs of retrieved documents that specify a port number are automatically resolved to preserve links in the retrieved document.
proxyUser _{string, optional}	edit When required by a proxy server, a valid username.
proxyPassword _{string, optional}	edit When required by a proxy server, a valid password.
bookmark _{boolean, optional}	edit Specifies whether bookmarks are created in the document
htmlbookmark _{boolean, optional}	edit If true, it is possible to convert outlines to a list of named anchors (`<a name="anchor_id">label</a>`) or a headings structure (`<h1>`...`<h6>`). Transforming of HTML hyperlinks to PDF hyperlinks (if not explicitly disabled). Hyperlink jumps within the same document are supported as well
localUrl _{boolean, optional}	edit Specifies whether to retrieve image files directly from the local drive
authUser _{string, optional}	edit User name sent to the target URL for Basic Authentication. Combined with password to form a base64 encoded string that is passed in the Authenticate header. Does not provide support for Integrated Windows, NTLM, or Kerberos authentication.
authPassword _{string, optional}	edit Password sent to the target URL for Basic Authentication. Combined with username to form a base64 encoded string that is passed in the Authenticate header. Does not provide support for Integrated Windows, NTLM, or Kerberos authentication.
userAgent _{string, optional}	edit Text to put in the HTTP User-Agent request header field. Used to identify the request client software.
saveAsName _{string, optional}	edit (format="PDF" only) The filename that appears in the SaveAs dialog when a user saves a PDF file written to the browser.

Unimplemented Attribute(s)

Attribute	Description
backgroundvisible _{boolean, optional}	edit Specifies whether the background prints when the user prints the document * unimplemented *
scale _{number, optional}	edit Define a scale factor as a percentage. This option is used to reduce the size of the HTML output so that it fits on that paper. Define a number less than 100. * unimplemented *

Examples

edit

Simple example for cfdocument

<cfdocument format="pdf">
	<h1>Welcome to Lucee</h1>
	<h5>Example Page</h5>
	<p>Example for <b>Cfdocument</b></p>
</cfdocument>

<cfdocument>

Unimplemented Attribute(s)

Examples

Simple example for cfdocument

See also