cfpdf

Manipulates existing PDF documents. The following list describes some of the
tasks you can perform with the cfpdf tag:
Merge several PDF documents into one PDF document.
Extract pages from multiple PDF documents and generate a new PDF document.
Linearize multipage PDF documents for faster display.
Encrypt or decrypt PDF files for security.

 <cfpdf>

 cfpdf();

cfpdf Attribute Reference

action

The action to take. Must be one of the following:
addwatermark
deletepages
getinfo
merge
protect
read
removewatermark
setinfo
write
(required) Values:
  • addwatermark
  • deletepages
  • getinfo
  • merge
  • protect
  • processddx
  • read
  • removewatermark
  • setinfo
  • thumbnail
  • write
  • extracttext
  • extractimage
  • addheader
  • addfooter
  • removeheaderfooter
  • optimize
  • transform

ascending

Order in which the PDF files are sorted:
yes: files are sorted in ascending order
no: files are sorted in descending order (optional, default=no)

copyfrom

The filename of the PDF document from which to copy the watermark (optional)

destination

The 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, ColdFusion creates it as long as
the parent directory exists. (optional)

directory

Specify the directory of the PDF documents to merge.
You must specify either the directory or the source.
If you specify the directory, you must also specify the order. (optional)

encrypt

Specify the type of encryption used on the source PDF document:
RC4_40, RC4_128M, AES_128, none (optional) Values:
  • RC4_40
  • RC4_128
  • RC4_128M
  • AES_128
  • none

flatten

Specify whether the output file is flattened:
yes: the formatting is removed and the file is flattened
no: the format of the source PDF is maintained in the output file. (optional,default=no)

foreground

Specify whether the watermark is placed in the foreground of the PDF document:
yes: the watermark appears in the foreground
no: the watermark appears in the background (optional, default=no)

image

Specify the image used as a watermark.
You can specify a filename or a ColdFusion image variable. (optional)

info

Specify the structure variable for relevant information, for example, #infoStruct#.
ColdFusion ignores read only information, such as the creation date, application used to create
the PDF document, and encryption parameters. (required)

isBase64

Specify whether the image used a watermark is in Base64 format:
yes: the image is in Base64 format
no: the image is not in Base64 format (optional, default=no)

keepbookmark
Default: YES

Specify whether bookmarks from the source PDF
documents are retained in the merged document:
yes: the bookmarks are retained
no: the bookmarks are removed (optional, default=no)

name

Specify the PDF document variable name, for example, myPDFdoc.
If the source is a PDF document variable, you cannot specify the
name attribute again; you can write the modified PDF document
to the destination. (optional)

newOwnerPassword

Specify the password for the owner of the PDF document. (optional)

newUserPassword

Specify the password for the user of the PDF document. (optional)

opacity

Specify the opacity of the watermark.
Valid values are integers in the range 0 (transparent)
through 10 (opaque). (optional, default=3)

order

Specify the order in which the PDF documents
in the directory are merged:
name: orders the documents alphabetically
time: orders the documents by timestamp (required) Values:
  • name
  • time

overwrite

Specify whether to overwrite the destination file:
yes: overwrites the destination file
no: does not overwrite the destination file (optional)

password

Specify the owner or user password of the source PDF document, if it exists. (optional)

permissions

Specify the type of permissions on the PDF document:
AllowPrintHigh
AllowPrintLow
AllowModify
AllowCopy
AllowAdd
AllowSecure
AllowModifyAnnotations
AllowExtract
AllowFillIn
all
none
Except for all or none, you can specify a
commaseparated list of permissions. (optional) Values:
  • all
  • allowassembly
  • allowcopy
  • AllowDegradedPrinting
  • AllowFillIn
  • AllowModifyAnnotations
  • AllowModifyContents
  • AllowPrinting
  • AllowScreenReaders
  • AllowSecure
  • none

position

Specify the 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. (optional)

rotation

Specify the degree of rotation of
the watermark image on the page; for example, 30. (optional) Values:
  • 0
  • 90
  • 180
  • 270

showonprint

Specify whether the watermark is printed with
the PDF document:
yes: the watermark is printed with the PDF document
no: the watermark is not printed with the PDF document (optional)

source

Specify the source. The source can be:
The pathname to a PDF document; for example, c:\work\myPDF.pdf
A PDF document variable in memory that is generated by the
cfdocument tag or the cfpdf tag; for example, #myPDFdoc#
The binary content of PDF document variable. (required)

type

Specify the type to remove from the source PDF document:
attachment
bookmark
watermark (optional) Values:
  • string
  • xml

version

(write) Specify the version of the PDF document to write.
Valid values are:
1.1
1.2

1.3
1.4
1.5
1.6 (optional) Values:
  • 1.1
  • 1.2
  • 1.3
  • 1.4
  • 1.5
  • 1.6

transparent
Default: NO

Specifies whether the image background is transparent or opaque: foormat=png only
* yes: the background is transparent.
* no: the background is opaque.

resolution

Image quality used to generate thumbnail images:
* high: use high resolution (uses more memory).
* low: use low resolution.

stoponerror
Default: 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.
* yes: stops the merge process if invalid PDF files exist in the specified directory.
* no: continues the merge process even if invalid files exist in the specified directory.

inputfiles

Structure that maps the PDF source files to the input variables in the DDX file, or a string of elements and their pathname.

scale

Size of the thumbnail relative to the source page. The value represents a percentage from 1 through 100.

imageprefix

Prefix used for each image thumbnail file generated. The image filenames use the format: imagePrefix_page_n.format.

outputfiles

Structure that contains the output files in the DDX file or string as keys and the pathname to the result file as the value.

pages

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".

ddxfile

Owner or user password of the source PDF document, if the document is password-protected.

saveoption
Default: full

Save options for the PDF output:
* full: normal save (default)
* incremental: required to save modifications to a signed PDF document.
* linear: for faster display. Values:
  • full
  • incremental
  • linear

format
Default: jpg

File type of thumbnail image output:
* jpg
* tiff
* png Values:
  • jpg
  • tiff
  • png

hires

Sets a high resolution for the thumbnail if set to yes.

maxScale

Specifies the maximum scale of the thumbnail

maxBreadth

Specifies maximum width of the thumbnail

maxLength

Specifies the maximum length of the thumbnail

compressTIFFs

Compress thumbnail which are in TIFF format.

overridepage

Specify whether to override page or not

package

Create PDF packages

hScale

Horizontal scale of the image to be modified. Valid values are hscale<1.

vScale

Vertical scale of the image to be modified. Valid values are vsacle<1.

noBookMarks

Remove bookmarks from PDF document

noAttachments

Removes all attachments from PDF documents.

noComments

Remove comments from PDF document

noJavaScripts

Remove all document level JavaScript actions

noMetadata

Remove document information and metadata

noThumbnails

Remove embedded page thumbnails

noFonts

Remove font styling

algo

Specifies the algorithm for image downsampling. Values:
  • Bicubic
  • Bilinear
  • Nearest_Neighbour

topMargin

No Help Available

leftMargin

Specifies the value of the leftMargin

rightMargin

Specifies the value of the rightMargin

bottomMargin

Specifies the value of the bottomMargin

numberFormat

Specify the numbering format for PDF pages in the footer. Values:
  • NUMERIC
  • LOWERCASEROMAN
  • UPPERCASEROMAN

align

Aligns the header and footer in PDF. Values:
  • right
  • left
  • center

honourspaces

Set this option to "true" if you need characters to be converted to spaces.

addQuads

Add the position or quadrants of the thumbnail

text

Specify Text Value Values:
  • _PAGELABEL
  • _LASTPAGELABEL
  • _PAGENUMBER
  • _LASTPAGENUMBER

useStructure

Specify whether to use structure or not

jpgdpi

encodeAll

Encode streams that are not encoded to optimize page content

Fork me on GitHub