<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.
Delete pages from a PDF document.
Merge pages from one or more PDF documents and generate a new PDF document.
Linearize PDF documents for faster web display.
Remove interactivity from forms created in Acrobat(c) to generate flat PDF documents.
Encrypt and add password protection to PDF documents.
Generate thumbnail images from PDF documents or pages. (not implemented yet)
Add or remove watermarks from PDF documents or pages.
Retrieve information associated with a PDF document, such as the software used to generate the file or the author, and set information for a PDF document, such as the title, author and keywords.
Create PDF portfolios
Add and remove header/footer from PDF documents
Optimize PDF documents
Extract all the words from the pdf
Extract images from PDF documents using the extractimage action.

This tag may have a body.

This tag is also supported within <cfscript>

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


		<cfpdf
    action=addHeader|addFooter|addWatermark|deletePages|extractBookmarks|extractImage|extractText|getInfo|merge|open|removePassword|protect|read|removeWatermark|setInfo|thumbnail|write
    ascending=boolean
    type=string
    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
    text=string
    numberformat=NUMERIC|LOWERCASEROMAN|UPPERCASEROMAN
    align=left|right|center
    leftmargin=numeric
    rightmargin=numeric
    topmargin=numeric
    bottommargin=numeric
><!--- body --->[</cfpdf>]

Merge PDF documents

action="merge" - Merges several PDF documents into one PDF document

Attribute	Description
action _{string, optional}	edit addHeader addFooter addWatermark deletePages extractText extractBookmarks getInfo merge open removePassword protect read removeWatermark setInfo thumbnail write extractimage (default) extractimages (alias for `extractimage`) Note: The `thumbnail` action was implemented in PDF Extension version 1.1.0.8. The `extractBookmarks` action was implemented in PDF Extension version 1.2.0.11-SNAPSHOT.
source _{any, optional}	edit PDF document used as the source.
directory _{string, optional}	edit 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.
filter _{string, optional}	edit file filter, used with attribute directory
ascending _{boolean, optional}	edit Order in which the PDF files are sorted
stopOnError _{boolean, optional}	edit Valid only if the directory attribute is specified. If the specified directory contains files other then readable PDF files, Lucee either stops merge process or continues.
destination _{string, optional}	edit 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.
name _{string, optional}	edit PDF document variable name _{Alias: variable}
overwrite _{boolean, optional}	edit Specifies whether PDF output overwrites the destination file
keepBookmark _{boolean, optional}	edit Specifies whether bookmarks from the source PDF documents are retained in the merged document
version _{number, optional}	edit Version of the PDF used to write the document

Read a PDF document

action="read" - Reads a PDF document and stores it in a variable

Attribute	Description
action _{string, optional}	edit addHeader addFooter addWatermark deletePages extractText extractBookmarks getInfo merge open removePassword protect read removeWatermark setInfo thumbnail write extractimage (default) extractimages (alias for `extractimage`) Note: The `thumbnail` action was implemented in PDF Extension version 1.1.0.8. The `extractBookmarks` action was implemented in PDF Extension version 1.2.0.11-SNAPSHOT.
source _{any, optional}	edit PDF document used as the source.
name _{string, optional}	edit PDF document variable name _{Alias: variable}
password _{string, optional}	edit Owner or user password of the source PDF document, if the document is password-protected.

Write a PDF document

action="write" - Writes a PDF document to a file

Attribute	Description
action _{string, optional}	edit addHeader addFooter addWatermark deletePages extractText extractBookmarks getInfo merge open removePassword protect read removeWatermark setInfo thumbnail write extractimage (default) extractimages (alias for `extractimage`) Note: The `thumbnail` action was implemented in PDF Extension version 1.1.0.8. The `extractBookmarks` action was implemented in PDF Extension version 1.2.0.11-SNAPSHOT.
source _{any, optional}	edit PDF document used as the source.
destination _{string, optional}	edit 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.
overwrite _{boolean, optional}	edit Specifies whether PDF output overwrites the destination file
version _{number, optional}	edit Version of the PDF used to write the document
encrypt _{string, optional}	edit Encryption type for the PDF output file
permissions _{string, optional}	edit type of permissions on the PDF document
newOwnerPassword _{string, optional}	edit Password used to set permissions on a PDF document
newUserPassword _{string, optional}	edit Password used to open PDF document

Protect a PDF document

action="protect" - Encrypts and adds password protection to PDF documents

Attribute	Description
action _{string, optional}	edit addHeader addFooter addWatermark deletePages extractText extractBookmarks getInfo merge open removePassword protect read removeWatermark setInfo thumbnail write extractimage (default) extractimages (alias for `extractimage`) Note: The `thumbnail` action was implemented in PDF Extension version 1.1.0.8. The `extractBookmarks` action was implemented in PDF Extension version 1.2.0.11-SNAPSHOT.
source _{any, optional}	edit PDF document used as the source.
destination _{string, optional}	edit 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.
name _{string, optional}	edit PDF document variable name _{Alias: variable}
overwrite _{boolean, optional}	edit Specifies whether PDF output overwrites the destination file
encrypt _{string, optional}	edit Encryption type for the PDF output file
permissions _{string, optional}	edit type of permissions on the PDF document
newOwnerPassword _{string, optional}	edit Password used to set permissions on a PDF document
newUserPassword _{string, optional}	edit Password used to open PDF document

Remove password protection

action="removePassword" - Removes password protection from a PDF document

Attribute	Description
action _{string, optional}	edit addHeader addFooter addWatermark deletePages extractText extractBookmarks getInfo merge open removePassword protect read removeWatermark setInfo thumbnail write extractimage (default) extractimages (alias for `extractimage`) Note: The `thumbnail` action was implemented in PDF Extension version 1.1.0.8. The `extractBookmarks` action was implemented in PDF Extension version 1.2.0.11-SNAPSHOT.
source _{any, optional}	edit PDF document used as the source.
destination _{string, optional}	edit 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.
name _{string, optional}	edit PDF document variable name _{Alias: variable}
password _{string, optional}	edit Owner or user password of the source PDF document, if the document is password-protected.
overwrite _{boolean, optional}	edit Specifies whether PDF output overwrites the destination file

Delete pages

action="deletePages" - Deletes pages from a PDF document

Attribute	Description
action _{string, optional}	edit addHeader addFooter addWatermark deletePages extractText extractBookmarks getInfo merge open removePassword protect read removeWatermark setInfo thumbnail write extractimage (default) extractimages (alias for `extractimage`) Note: The `thumbnail` action was implemented in PDF Extension version 1.1.0.8. The `extractBookmarks` action was implemented in PDF Extension version 1.2.0.11-SNAPSHOT.
source _{any, optional}	edit PDF document used as the source.
pages _{string, optional}	edit 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".
destination _{string, optional}	edit 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.
name _{string, optional}	edit PDF document variable name _{Alias: variable}
password _{string, optional}	edit Owner or user password of the source PDF document, if the document is password-protected.
overwrite _{boolean, optional}	edit Specifies whether PDF output overwrites the destination file

Generate thumbnail images

action="thumbnail" - Generates thumbnail images from PDF document pages

Attribute	Description
action _{string, optional}	edit addHeader addFooter addWatermark deletePages extractText extractBookmarks getInfo merge open removePassword protect read removeWatermark setInfo thumbnail write extractimage (default) extractimages (alias for `extractimage`) Note: The `thumbnail` action was implemented in PDF Extension version 1.1.0.8. The `extractBookmarks` action was implemented in PDF Extension version 1.2.0.11-SNAPSHOT.
source _{any, optional}	edit PDF document used as the source.
destination _{string, optional}	edit 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.
pages _{string, optional}	edit 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".
format _{string, optional}	edit File type of thumbnail image output
imagePrefix _{string, optional}	edit prefix used for each image thumbnail file generated. The image filenames use the format: imagePrefix_page_n.format.
resolution _{string, optional}	edit Image quality used to generate thumbnail images
scale _{number, optional}	edit Size of the thumbnail relative to the source page. The value represents a percentage from 1 through 100.
transparent _{boolean, optional}	edit (format="png" only) Specifies whether the image background is transparent or opaque
overwrite _{boolean, optional}	edit Specifies whether PDF output overwrites the destination file
password _{string, optional}	edit Owner or user password of the source PDF document, if the document is password-protected.

Extract text

action="extractText" - Extracts text from a PDF document

Attribute	Description
action _{string, optional}	edit addHeader addFooter addWatermark deletePages extractText extractBookmarks getInfo merge open removePassword protect read removeWatermark setInfo thumbnail write extractimage (default) extractimages (alias for `extractimage`) Note: The `thumbnail` action was implemented in PDF Extension version 1.1.0.8. The `extractBookmarks` action was implemented in PDF Extension version 1.2.0.11-SNAPSHOT.
source _{any, optional}	edit PDF document used as the source.
destination _{string, optional}	edit 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.
name _{string, optional}	edit PDF document variable name _{Alias: variable}
pages _{string, optional}	edit 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".
type _{string, optional}	edit used for action "extractText", defines the format type of the extraction, valid values are: string,xml
password _{string, optional}	edit Owner or user password of the source PDF document, if the document is password-protected.
overwrite _{boolean, optional}	edit Specifies whether PDF output overwrites the destination file

Extract images

action="extractImage" - Extracts images from a PDF document

Attribute	Description
action _{string, optional}	edit addHeader addFooter addWatermark deletePages extractText extractBookmarks getInfo merge open removePassword protect read removeWatermark setInfo thumbnail write extractimage (default) extractimages (alias for `extractimage`) Note: The `thumbnail` action was implemented in PDF Extension version 1.1.0.8. The `extractBookmarks` action was implemented in PDF Extension version 1.2.0.11-SNAPSHOT.
source _{any, optional}	edit PDF document used as the source.
destination _{string, optional}	edit 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.
pages _{string, optional}	edit 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".
imagePrefix _{string, optional}	edit prefix used for each image thumbnail file generated. The image filenames use the format: imagePrefix_page_n.format.
format _{string, optional}	edit File type of thumbnail image output
overwrite _{boolean, optional}	edit Specifies whether PDF output overwrites the destination file
password _{string, optional}	edit Owner or user password of the source PDF document, if the document is password-protected.

Extract bookmarks

action="extractBookmarks" - Extracts bookmarks from a PDF document

Attribute	Description
action _{string, optional}	edit addHeader addFooter addWatermark deletePages extractText extractBookmarks getInfo merge open removePassword protect read removeWatermark setInfo thumbnail write extractimage (default) extractimages (alias for `extractimage`) Note: The `thumbnail` action was implemented in PDF Extension version 1.1.0.8. The `extractBookmarks` action was implemented in PDF Extension version 1.2.0.11-SNAPSHOT.
source _{any, optional}	edit PDF document used as the source.
name _{string, optional}	edit PDF document variable name _{Alias: variable}
password _{string, optional}	edit Owner or user password of the source PDF document, if the document is password-protected.

Add watermark

action="addWatermark" - Adds a watermark to PDF document pages

Attribute	Description
action _{string, optional}	edit addHeader addFooter addWatermark deletePages extractText extractBookmarks getInfo merge open removePassword protect read removeWatermark setInfo thumbnail write extractimage (default) extractimages (alias for `extractimage`) Note: The `thumbnail` action was implemented in PDF Extension version 1.1.0.8. The `extractBookmarks` action was implemented in PDF Extension version 1.2.0.11-SNAPSHOT.
source _{any, optional}	edit PDF document used as the source.
copyFrom _{any, optional}	edit Pathname of the PDF document from which to use the first page as a watermark
image _{any, optional}	edit Image used as a watermark. You can specify a pathname, a variable that contains an image file, or an image variable
pages _{string, optional}	edit 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".
destination _{string, optional}	edit 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.
name _{string, optional}	edit PDF document variable name _{Alias: variable}
password _{string, optional}	edit Owner or user password of the source PDF document, if the document is password-protected.
overwrite _{boolean, optional}	edit Specifies whether PDF output overwrites the destination file
foreground _{boolean, optional}	edit Placement of the watermark on the page
opacity _{number, optional}	edit Opacity of the watermark. Valid values are integers in the range 0 (transparent) through 10 (opaque).
position _{string, optional}	edit 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".
rotation _{number, optional}	edit Degree of rotation of the watermark image on the page.

Remove watermark

action="removeWatermark" - Removes watermarks from a PDF document

Attribute	Description
action _{string, optional}	edit addHeader addFooter addWatermark deletePages extractText extractBookmarks getInfo merge open removePassword protect read removeWatermark setInfo thumbnail write extractimage (default) extractimages (alias for `extractimage`) Note: The `thumbnail` action was implemented in PDF Extension version 1.1.0.8. The `extractBookmarks` action was implemented in PDF Extension version 1.2.0.11-SNAPSHOT.
source _{any, optional}	edit PDF document used as the source.
pages _{string, optional}	edit 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".
destination _{string, optional}	edit 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.
name _{string, optional}	edit PDF document variable name _{Alias: variable}
password _{string, optional}	edit Owner or user password of the source PDF document, if the document is password-protected.
overwrite _{boolean, optional}	edit Specifies whether PDF output overwrites the destination file

Add header

action="addHeader" - Adds a header to PDF document pages

Attribute	Description
action _{string, optional}	edit addHeader addFooter addWatermark deletePages extractText extractBookmarks getInfo merge open removePassword protect read removeWatermark setInfo thumbnail write extractimage (default) extractimages (alias for `extractimage`) Note: The `thumbnail` action was implemented in PDF Extension version 1.1.0.8. The `extractBookmarks` action was implemented in PDF Extension version 1.2.0.11-SNAPSHOT.
source _{any, optional}	edit PDF document used as the source.
destination _{string, optional}	edit 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.
name _{string, optional}	edit PDF document variable name _{Alias: variable}
pages _{string, optional}	edit 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".
text _{string, optional}	edit text for header or footer, you can add the following place holders within the text: _PAGELABEL: add current page label _LASTPAGELABEL: add last page label _PAGENUMBER: add current page number _LASTPAGENUMBER: add last page number
align _{string, optional}	edit Aligns the header and footer in PDF: left right center
leftmargin _{numeric, optional}	edit left margin of the text in header/footer
rightmargin _{numeric, optional}	edit right margin of the text in header/footer
topmargin _{numeric, optional}	edit top margin of the text in header
numberformat _{string, optional}	edit Specify the numbering format for PDF pages in the header/footer. possible values are: LOWERCASEROMAN UPPERCASEROMAN NUMERIC
password _{string, optional}	edit Owner or user password of the source PDF document, if the document is password-protected.
overwrite _{boolean, optional}	edit Specifies whether PDF output overwrites the destination file

Add footer

action="addFooter" - Adds a footer to PDF document pages

Attribute	Description
action _{string, optional}	edit addHeader addFooter addWatermark deletePages extractText extractBookmarks getInfo merge open removePassword protect read removeWatermark setInfo thumbnail write extractimage (default) extractimages (alias for `extractimage`) Note: The `thumbnail` action was implemented in PDF Extension version 1.1.0.8. The `extractBookmarks` action was implemented in PDF Extension version 1.2.0.11-SNAPSHOT.
source _{any, optional}	edit PDF document used as the source.
destination _{string, optional}	edit 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.
name _{string, optional}	edit PDF document variable name _{Alias: variable}
pages _{string, optional}	edit 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".
text _{string, optional}	edit text for header or footer, you can add the following place holders within the text: _PAGELABEL: add current page label _LASTPAGELABEL: add last page label _PAGENUMBER: add current page number _LASTPAGENUMBER: add last page number
align _{string, optional}	edit Aligns the header and footer in PDF: left right center
leftmargin _{numeric, optional}	edit left margin of the text in header/footer
rightmargin _{numeric, optional}	edit right margin of the text in header/footer
bottommargin _{numeric, optional}	edit bottom margin of the text in footer
numberformat _{string, optional}	edit Specify the numbering format for PDF pages in the header/footer. possible values are: LOWERCASEROMAN UPPERCASEROMAN NUMERIC
password _{string, optional}	edit Owner or user password of the source PDF document, if the document is password-protected.
overwrite _{boolean, optional}	edit Specifies whether PDF output overwrites the destination file

Get document information

action="getInfo" - Retrieves information about a PDF document

Attribute	Description
action _{string, optional}	edit addHeader addFooter addWatermark deletePages extractText extractBookmarks getInfo merge open removePassword protect read removeWatermark setInfo thumbnail write extractimage (default) extractimages (alias for `extractimage`) Note: The `thumbnail` action was implemented in PDF Extension version 1.1.0.8. The `extractBookmarks` action was implemented in PDF Extension version 1.2.0.11-SNAPSHOT.
source _{any, optional}	edit PDF document used as the source.
name _{string, optional}	edit PDF document variable name _{Alias: variable}
password _{string, optional}	edit Owner or user password of the source PDF document, if the document is password-protected.

Set document information

action="setInfo" - Sets information for a PDF document such as title, author, and keywords

Attribute	Description
action _{string, optional}	edit addHeader addFooter addWatermark deletePages extractText extractBookmarks getInfo merge open removePassword protect read removeWatermark setInfo thumbnail write extractimage (default) extractimages (alias for `extractimage`) Note: The `thumbnail` action was implemented in PDF Extension version 1.1.0.8. The `extractBookmarks` action was implemented in PDF Extension version 1.2.0.11-SNAPSHOT.
source _{any, optional}	edit PDF document used as the source.
info _{struct, optional}	edit Structure variable for relevant information
destination _{string, optional}	edit 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.
name _{string, optional}	edit PDF document variable name _{Alias: variable}
password _{string, optional}	edit Owner or user password of the source PDF document, if the document is password-protected.
overwrite _{boolean, optional}	edit Specifies whether PDF output overwrites the destination file

Unimplemented Attribute(s)

Attribute	Description
ddxfile _{string, optional}	edit Pathname of the DDX file, or a string with DDX instructions * unimplemented *
flatten _{boolean, optional}	edit Applies to forms created in Acrobat only (not forms created in LiveCycle); specifies whether interactivity is turned off * unimplemented *
inputFiles _{struct, optional}	edit Structure that maps the PDF source files to the input variables in the DDX file, or a string of elements and their pathname. * unimplemented *
isBase64 _{boolean, optional}	edit Valid only when the image attribute is specified. Specifies whether the image used as a watermark is in Base64 format * unimplemented *
order _{string, optional}	edit Order in which the PDF documents in the directory are merged * unimplemented *
outputFiles _{struct, optional}	edit Structure that contains the output files in the DDX file or string as keys and the pathname to the result file as the value. * unimplemented *
saveOption _{string, optional}	edit Save options for the PDF output * unimplemented *
showOnPrint _{boolean, optional}	edit Specify whether to print the watermark with the PDF document * unimplemented *

Examples

edit

There are currently no examples for this tag.