Contents

cfpdf

Description

Category

Other

Implemented

Usage Syntax

<cfpdf  
	[action="String"]
	[ascending="Boolean"]
	[copyFrom="Any"]
	[ddxfile="String"]
	[destination="String"]
	[directory="String"]
	[encrypt="String"]
	[flatten="Boolean"]
	[foreground="Boolean"]
	[format="String"]
	[image="Any"]
	[imagePrefix="String"]
	[filter="String"]
	[info="Struct"]
	[inputFiles="Struct"]
	[isBase64="Boolean"]
	[keepBookmark="Boolean"]
	[name="String"]
	[newOwnerPassword="String"]
	[newUserPassword="String"]
	[opacity="number"]
	[order="String"]
	[outputFiles="Struct"]
	[overwrite="Boolean"]
	[pages="String"]
	[password="String"]
	[permissions="String"]
	[position="String"]
	[resolution="String"]
	[rotation="number"]
	[saveOption="String"]
	[scale="number"]
	[showOnPrint="Boolean"]
	[source="Any"]
	[stopOnError="Boolean"]
	[transparent="Boolean"]
	[version="number"]
 />

[] = Optional attribute

Attributes

Name Type Required Default Description
action String No action to take
ascending Boolean No Order in which the PDF files are sorted
copyFrom Any No Pathname of the PDF document from which to use the first page as a watermark
ddxfile String No Pathname of the DDX file, or a string with DDX instructions
destination String No Pathname of the modified PDF document. If the destination file exists, you must set the overwrite attribute to yes. If the destination file does not exist, CFML creates the file, if the parent directory exists.
directory String No Directory of the PDF documents to merge. You must specify either the directory attribute or the source attribute. If you specify the directory attribute, CFML orders the documents by filename in descending order, by default. To change the order of the files, use the order attribute.
encrypt String No Encryption type for the PDF output file
flatten Boolean No Applies to forms created in Acrobat only (not forms created in LiveCycle); specifies whether interactivity is turned off
foreground Boolean No Placement of the watermark on the page
format String No File type of thumbnail image output
image Any No Image used as a watermark. You can specify a pathname, a variable that contains an image file, or a ColdFusion image variable
imagePrefix String No prefix used for each image thumbnail file generated. The image filenames use the format: imagePrefix_page_n.format.
filter String No file filter, used with attribute directory
info Struct No Structure variable for relevant information
inputFiles Struct No Structure that maps the PDF source files to the input variables in the DDX file, or a string of elements and their pathname.
isBase64 Boolean No Valid only when the image attribute is specified. Specifies whether the image used as a watermark is in Base64 format
keepBookmark Boolean No Specifies whether bookmarks from the source PDF documents are retained in the merged document
name String No PDF document variable name
newOwnerPassword String No Password used to set permissions on a PDF document
newUserPassword String No Password used to open PDF document
opacity number No Opacity of the watermark. Valid values are integers in the range 0 (transparent) through 10 (opaque).
order String No Order in which the PDF documents in the directory are merged
outputFiles Struct No Structure that contains the output files in the DDX file or string as keys and the pathname to the result file as the value.
overwrite Boolean No Specifies whether PDF output overwrites the destination file
pages String No Page or pages in the source PDF document on which to perform the action. You can specify multiple pages and page ranges as follows: "1,6-9,56-89,100, 110-120".
password String No Owner or user password of the source PDF document, if the document is password-protected.
permissions String No type of permissions on the PDF document
position String No Position on the page where the watermark is placed. The position represents the top-left corner of the watermark. Specify the x and y coordinates; for example "50,30".
resolution String No Image quality used to generate thumbnail images
rotation number No Degree of rotation of the watermark image on the page.
saveOption String No Save options for the PDF output
scale number No Size of the thumbnail relative to the source page. The value represents a percentage from 1 through 100.
showOnPrint Boolean No Specify whether to print the watermark with the PDF document
source Any No PDF document used as the source.
stopOnError Boolean No Valid only if the directory attribute is specified. If the specified directory contains files other then ColdFusion-readable PDF files, ColdFusion either stops merge process or continues.
transparent Boolean No (format="png" only) Specifies whether the image background is transparent or opaque
version number No Version of the PDF used to write the document

Example Usage