cfdocument

Overview ColdFusion Open BlueDragon Lucee

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

Attributes

Name Required Type Default Description
8
3
authpassword No String 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 Kerebos authentication.
8
3
authuser No String 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 Kerebos authentication.
backgroundvisible No Boolean false Specifies whether the background prints when the user prints the document: - yes: include the background when printing. - no: do not include the background when printing.
8
3
bookmark No Boolean false Specifies whether bookmarks are created in the document: * yes: creates bookmarks. * no: does not create bookmarks.
encryption No String none Specifies whether the output is encrypted (format="PDF" only). Default is: none
filename No String Specifies the fully qualified path name of a file to contain the PDF or FlashPaper output. If you omit the filename attribute, ColdFusion MX streams output to the browser.
fontembed No Boolean true Specifies whether ColdFusion embeds fonts in the output. Specify one of the following: - true: Embed fonts - false: Do not embed fonts. Selective: Embed all fonts except Java fonts and core fonts.
format Yes String Specifies the report format.
9
formFields No Boolean true Specifies whether form fields are exported as widgets or only their fixed print representation is exported.
9
formsType No String FDF Specifies the submitted format of a PDF form.
3
htmlbookmark No if true it is possible to convert to outlines a list of named anchors (label) or a headings structure (

...

). Transforming of HTML hyperlinks to PDF hyperlinks (if not explicitely disabled). Hyperlink jumps within the same document are supported as well
8
3
localurl No Boolean false Specifies whether to retrieve image files directly from the local drive: * yes: ColdFusion retrieves image files directly from the local drive rather than by using HTTP, HTTPS, or proxy. * no: ColdFusion uses HTTP, HTTPS, or proxy to retrieve image files even if the files are stored locally.
marginbottom No String Specifies the bottom margin in inches (default) or centimeters. To specify bottom margin in centimeters, include the unit=cm attribute.
marginleft No String Specifies the left margin in inches (default) or centimeters. To specify left margin in centimeters, include the unit=cm attribute.
marginright No String Specifies the right margin in inches (default) or centimeters. To specify right margin in centimeters, include the unit=cm attribute.
margintop No Numeric Specifies the top margin in inches (default) or centimeters. To specify top margin in centimeters, include the unit=cm attribute.
8
mimetype No String text/html MIME type of the source document
name No String Specifies the name of an existing variable into which the tag stores the PDF or FlashPaper output.
9
openPassword No String If the source document is protected specify using this attribute.
orientation No String portrait Specifies the page orientation. Specify either of the following: - portrait (default) - landscape
overwrite No Boolean false Specifies whether ColdFusion MX overwrites an existing file. Used in conjunction with filename. Default is: false
ownerpassword No String Specifies an owner password (format="PDF" only).
pageheight No Numeric Specifies the page height in inches (default) or centimeters. This attribute is only valid if pagetype=custom. To specify page height in centimeters, include the unit=cm attribute.
pagetype No String A4 Specifies the page size into which ColdFusion generates the report. - legal: 8.5 inches x 14 inches - letter: 8.5 inches x 11 inches - A4: 8.27 inches x 11.69 inches - A5: 5.81 inches x 8.25 inches - B5: 9.81 inches x 13.88 inches - Custom: Custom height and width. If you specify custom, you must also specify the pageheight and pagewidth attributes, can optionally specify margin attributes, and can optionally specify whether the units are inches or centimeters.
pagewidth No Numeric Specifies the page width in inches (default) or centimeters. This attribute is only valid if pagetype=custom. To specify page width in centimeters, include the unit=cm attribute.
9
pdfa No Boolean false Creates a PDF of type PDF/A-1 (ISO 19005-1:2005)
permissions No String Specifies one or more permissions (format="PDF" only). Separate multiple permissions with a comma.
9
permissionsPassword No String This is the password that allows the user to access some permissions restricted if some permissions need to be restricted. The permissions are defined in "permissions" attribute
8
3
proxyhost No String IP address or server name for proxy host.
8
proxypassword No String Password required by the proxy server.
8
proxyport No String Port of the proxy host.
proxyserver No Host name or IP address of a proxy server.
8
proxyuser No String User name to provide to the proxy server.
8
3
saveasname No String (format="PDF" only) The filename that appears in the SaveAs dialog when a user saves a PDF file written to the browser.
scale No Numeric Specifies a scale factor as a percentage. Use this option to reduce the size of the HTML output so that it fits on that paper. Specify a number less than 100.
8
src No String URL or the relative path to the web root. You cannot specify both the src and srcfile attributes. The file must be in a browser-writable format such as, HTML, HTM, BMP, PNG, and so on.
8
srcfile No String Absolute path of a file that is on the server. You cannot specify both the src and srcfile attributes. The file must be in a browser-writable format such as, HTML, HTM, BMP, PNG, and so on.
9
tagged No Boolean false Determines if PDF are created by using special tags also known as Tagged PDF
unit No String in Specifies the default unit (inches or centimeters) for pageheight, pagewidth, and margin attributes.
8
3
useragent No String Text to put in the HTTP User-Agent request header field. Used to identify the request client software.
userpassword No String Specifies a user password (format="PDF" only).