- CFML Reference User Guide
- ColdFusion functions
- ColdFusion functions by category
- Functions a-b
- Abs
- ACos
- AddSOAPRequestHeader
- AddSOAPResponseHeader
- AjaxLink
- AjaxOnLoad
- ApplicationStop
- ArrayAppend
- ArrayAvg
- ArrayClear
- ArrayContains
- ArrayContainsNoCase
- ArrayDelete
- ArrayDeleteAt
- ArrayDeleteNoCase
- ArrayEach
- ArrayFilter
- ArrayFind
- ArrayFindAll
- ArrayFindAllNoCase
- ArrayFindNoCase
- ArrayInsertAt
- ArrayIsDefined
- ArrayIsEmpty
- ArrayLen
- ArrayMap
- ArrayMax
- ArrayMin
- ArrayNew
- ArrayPrepend
- ArrayReduce
- ArrayResize
- ArraySet
- ArraySetMetadata
- ArraySlice
- ArraySort
- ArraySum
- ArraySwap
- ArrayToList
- Asc
- ASin
- Atn
- AuthenticatedContext
- AuthenticatedUser
- BinaryDecode
- BinaryEncode
- BitAnd
- BitMaskClear
- BitMaskRead
- BitMaskSet
- BitNot
- BitOr
- BitSHLN
- BitSHRN
- BitXor
- BooleanFormat
- Abs
- Functions-c-d
- CacheGet
- CacheGetAllIds
- CacheGetMetadata
- CacheGetProperties
- CacheGetSession
- CacheIdExists
- CachePut
- CacheRegionExists
- CacheRegionNew
- CacheRegionRemove
- CacheRemove
- CacheRemoveAll
- CacheSetProperties
- CallStackDump
- CallStackGet
- CanDeSerialize
- Canonicalize
- CanSerialize
- Ceiling
- CharsetDecode
- CharsetEncode
- Chr
- CJustify
- Compare
- CompareNoCase
- Cos
- CreateDate
- CreateDateTime
- CreateObject
- CreateObject: .NET object
- CreateObject: COM object
- CreateObject: component object
- CreateObject: CORBA object
- CreateObject: Java or EJB object
- CreateObject: web service object
- CreateODBCDate
- CreateODBCDateTime
- CreateODBCTime
- CreateSignedJWT
- CreateEncryptedJWT
- CreateTime
- CreateTimeSpan
- CreateUUID
- CSRFGenerateToken
- CSRFVerifyToken
- DateAdd
- DateCompare
- DateConvert
- DateDiff
- DateFormat
- DatePart
- DateTimeFormat
- Day
- DayOfWeek
- DayOfWeekAsString
- DayOfYear
- DaysInMonth
- DaysInYear
- DE
- DecimalFormat
- DecodeForHTML
- DecodeFromURL
- DecrementValue
- Decrypt
- DecryptBinary
- DeleteClientVariable
- Deserialize
- DeserializeJSON
- DeserializeXML
- DirectoryCopy
- DirectoryCreate
- DirectoryDelete
- DirectoryExists
- DirectoryList
- DirectoryRename
- DollarFormat
- DotNetToCFType
- Duplicate
- Functions-e-g
- EncodeForCSS
- EncodeForDN
- EncodeForHTML
- EncodeForHTMLAttribute
- EncodeForJavaScript
- EncodeForLDAP
- EncodeForURL
- EncodeForXML
- EncodeForXMLAttribute
- EncodeForXpath
- Encrypt
- EncryptBinary
- EntityDelete
- EntityLoad
- EntityLoadByExample
- EntityLoadByPK
- EntityMerge
- EntityNew
- EntityReload
- EntitySave
- EntityToQuery
- Evaluate
- Exp
- ExpandPath
- FileClose
- FileCopy
- FileDelete
- FileExists
- FileGetMimeType
- FileIsEOF
- FileMove
- FileOpen
- FileRead
- FileReadBinary
- FileReadLine
- FileSeek
- FileSetAccessMode
- FileSetAttribute
- FileSetLastModified
- FileSkipBytes
- FileUpload
- FileUploadAll
- FileWrite
- FileWriteLine
- Find
- FindNoCase
- FindOneOf
- FirstDayOfMonth
- Fix
- Floor
- FormatBaseN
- GeneratePBKDFKey
- GenerateSecretKey
- GetApplicationMetadata
- GetAuthUser
- GetBaseTagData
- GetBaseTagList
- GetBaseTemplatePath
- GetClientVariablesList
- GetComponentMetaData
- GetContextRoot
- GetCPUUsage
- GetCurrentTemplatePath
- GetDirectoryFromPath
- GetEncoding
- GetException
- GetFileFromPath
- GetFileInfo
- GetFreeSpace
- GetFunctionCalledName
- GetFunctionList
- GetGatewayHelper
- GetHttpRequestData
- GetHttpTimeString
- GetK2ServerDocCount
- GetK2ServerDocCountLimit
- GetLocale
- GetLocaleDisplayName
- GetLocalHostIP
- GetMetaData
- GetMetricData
- GetPageContext
- GetPrinterInfo
- GetPrinterList
- GetProfileSections
- GetProfileString
- GetReadableImageFormats
- GetSafeHTML
- GetSAMLAuthRequest
- GetSAMLLogoutRequest
- GenerateSAMLSPMetadata
- GetSOAPRequest
- GetSOAPRequestHeader
- GetSOAPResponse
- GetSOAPResponseHeader
- GetSystemFreeMemory
- GetSystemTotalMemory
- GetTempDirectory
- GetTempFile
- GetTemplatePath
- GetTickCount
- GetTimeZoneInfo
- GetToken
- GetTotalSpace
- GetUserRoles
- GetVFSMetaData
- GetWriteableImageFormats
- Functions-h-im
- Hash
- HMac
- Hour
- HQLMethods
- HTMLCodeFormat
- HTMLEditFormat
- IIf
- ImageAddBorder
- ImageBlur
- ImageClearRect
- ImageCopy
- ImageCreateCaptcha
- ImageCrop
- ImageDrawArc
- ImageDrawBeveledRect
- ImageDrawCubicCurve
- ImageDrawLine
- ImageDrawLines
- ImageDrawOval
- ImageDrawPoint
- ImageDrawQuadraticCurve
- ImageDrawRect
- ImageDrawRoundRect
- ImageDrawText
- ImageFlip
- ImageGetBlob
- ImageGetBufferedImage
- ImageGetEXIFMetadata
- ImageGetEXIFTag
- ImageGetHeight
- ImageGetIPTCMetadata
- ImageGetIPTCTag
- ImageGetMetadata
- ImageGetWidth
- ImageGrayscale
- ImageInfo
- ImageMakeColorTransparent
- ImageMakeTranslucent
- ImageNegative
- ImageNew
- ImageOverlay
- ImagePaste
- ImageRead
- ImageReadBase64
- ImageResize
- ImageRotate
- ImageRotateDrawingAxis
- ImageScaleToFit
- ImageSetAntialiasing
- ImageSetBackgroundColor
- ImageSetDrawingColor
- ImageSetDrawingStroke
- ImageSetDrawingTransparency
- ImageSharpen
- ImageShear
- ImageShearDrawingAxis
- ImageTranslate
- ImageTranslateDrawingAxis
- ImageWrite
- ImageWriteBase64
- ImageXORDrawingMode
- Functions-in-k
- IncrementValue
- InputBaseN
- Insert
- Int
- InvalidateOauthAccesstoken
- Invoke
- InitSAMLAuthRequest
- InitSAMLLogoutRequest
- InvokeCFClientFunction
- IsArray
- IsAuthenticated
- IsAuthorized
- IsBinary
- IsBoolean
- IsClosure
- IsCustomFunction
- IsDate
- IsDateObject
- IsDDX
- IsDebugMode
- IsDefined
- IsImage
- IsImageFile
- IsInstanceOf
- IsIPv6
- IsJSON
- IsK2ServerABroker
- IsK2ServerDocCountExceeded
- IsK2ServerOnline
- IsLeapYear
- IsLocalHost
- IsNull
- IsNumeric
- IsNumericDate
- IsObject
- isOnline
- IsPDFArchive
- IsPDFFile
- IsPDFObject
- IsProtected
- IsQuery
- isSamlLogoutResponse
- isSafeHTML
- IsSimpleValue
- IsSOAPRequest
- IsSpreadsheetFile
- IsSpreadsheetObject
- IsStruct
- IsUserInAnyRole
- IsUserInRole
- IsUserLoggedIn
- IsValid
- IsValidOauthAccesstoken
- IsWDDX
- IsXML
- IsXmlAttribute
- IsXmlDoc
- IsXmlElem
- IsXmlNode
- IsXmlRoot
- JavaCast
- JSStringFormat
- Functions-l
- LCase
- Left
- Len
- ListAppend
- ListChangeDelims
- ListContains
- ListContainsNoCase
- ListDeleteAt
- ListEach
- ListFilter
- ListFind
- ListFindNoCase
- ListFirst
- ListGetAt
- ListInsertAt
- ListLast
- ListLen
- ListMap
- ListPrepend
- ListQualify
- ListReduce
- ListRemoveDuplicates
- ListRest
- ListSetAt
- ListSort
- ListToArray
- ListValueCount
- ListValueCountNoCase
- LJustify
- Location
- Log
- Log10
- LSCurrencyFormat
- LSDateFormat
- LSDateTimeFormat
- LSEuroCurrencyFormat
- LSIsCurrency
- LSIsDate
- LSIsNumeric
- LSNumberFormat
- LSParseCurrency
- LSParseDateTime
- LSParseEuroCurrency
- LSParseNumber
- LSTimeFormat
- LTrim
- Functions-m-r
- Max
- Mid
- Min
- Minute
- Month
- MonthAsString
- Now
- NumberFormat
- ObjectEquals
- ObjectLoad
- ObjectSave
- OnWSAuthenticate
- ORMClearSession
- ORMCloseAllSessions
- ORMCloseSession
- ORMEvictCollection
- ORMEvictEntity
- ORMEvictQueries
- ORMExecuteQuery
- ORMFlush
- ORMFlushall
- ORMGetSession
- ORMGetSessionFactory
- ORMIndex
- ORMIndexPurge
- ORMReload
- ORMSearch
- ORMSearchOffline
- ParagraphFormat
- ParameterExists
- ParseDateTime
- Pi
- PrecisionEvaluate
- ProcessSAMLResponse
- ProcessSAMLLogoutRequest
- Quarter
- PreserveSingleQuotes
- QueryAddColumn
- QueryAddRow
- QueryConvertForGrid
- QueryExecute
- QueryFilter
- QueryGetResult
- QueryGetRow
- QueryKeyExists
- QueryMap
- QueryNew
- QueryReduce
- QuerySetCell
- QuotedValueList
- QueryEach
- Rand
- Randomize
- RandRange
- ReEscape
- REFind
- REFindNoCase
- ReleaseComObject
- REMatch
- REMatchNoCase
- RemoveCachedQuery
- RemoveChars
- RepeatString
- Replace
- ReplaceList
- ReplaceNoCase
- REReplace
- REReplaceNoCase
- RestDeleteApplication
- RestSetResponse
- RestInitApplication
- Reverse
- Right
- RJustify
- Round
- RTrim
- Functions-s
- Second
- SendGatewayMessage
- SendSAMLLogoutResponse
- Serialize
- SerializeJSON
- SerializeXML
- SessionInvalidate
- SessionRotate
- SessionGetMetaData
- SessionInvalidate
- SessionRotate
- SetDay
- SetEncoding
- SetHour
- SetLocale
- SetMonth
- SetProfileString
- SetVariable
- SetYear
- Sgn
- Sin
- Sleep
- SpanExcluding
- SpanIncluding
- SpreadsheetAddAutoFilter
- SpreadsheetAddColumn
- SpreadsheetAddFreezePane
- SpreadsheetAddImage
- SpreadsheetAddInfo
- SpreadsheetAddPageBreaks
- SpreadsheetAddRow
- SpreadsheetAddRows
- SpreadsheetAddSplitPane
- SpreadsheetCreateSheet
- SpreadsheetDeleteColumn
- SpreadsheetDeleteColumns
- SpreadsheetDeleteRow
- SpreadsheetDeleteRows
- SpreadsheetFormatCell
- SpreadsheetFormatColumn
- SpreadsheetFormatCellRange
- SpreadsheetFormatColumn
- SpreadsheetFormatColumns
- SpreadsheetFormatRow
- SpreadsheetFormatRows
- SpreadsheetGetCellComment
- SpreadsheetGetCellFormula
- SpreadsheetGetCellValue
- SpreadsheetGetColumnCount
- SpreadsheetInfo
- SpreadsheetMergeCells
- SpreadsheetNew
- SpreadsheetRead
- SpreadsheetReadBinary
- SpreadsheetRemoveSheet
- SpreadsheetSetActiveSheet
- SpreadsheetSetActiveSheetNumber
- SpreadsheetSetCellComment
- SpreadsheetSetCellFormula
- SpreadsheetSetCellValue
- SpreadsheetSetColumnWidth
- SpreadsheetSetFooter
- SpreadsheetSetHeader
- SpreadsheetSetRowHeight
- SpreadsheetShiftColumns
- SpreadsheetShiftRows
- SpreadsheetWrite
- Sqr
- StripCR
- StructAppend
- StructClear
- StructCopy
- StructCount
- StructDelete
- StructEach
- StructFilter
- StructFind
- StructFindKey
- StructFindValue
- StructGet
- StructGetMetadata
- StructInsert
- StructIsEmpty
- StructKeyArray
- StructKeyExists
- StructKeyList
- StructMap
- StructNew
- StructReduce
- StructSetMetadata
- StructSort
- StructToSorted
- StructUpdate
- StoreSetMetadata
- StoreGetACL
- StoreGetMetadata
- StoreAddACL
- StoreSetACL
- Functions-t-z
- Tan
- ThreadJoin
- ThreadTerminate
- Throw
- TimeFormat
- ToBase64
- ToBinary
- ToScript
- ToString
- Trace
- Transactionandconcurrency
- TransactionCommit
- TransactionRollback
- TransactionSetSavePoint
- Trim
- UCase
- URLDecode
- URLEncodedFormat
- URLSessionFormat
- Val
- ValueList
- VerifyClient
- Week
- Wrap
- WriteDump
- WriteLog
- WriteOutput
- WSGetAllChannels
- WSGetSubscribers
- WSPublish
- WSSendMessage
- XmlChildPos
- XmlElemNew
- XmlFormat
- XmlGetNodeType
- XmlNew
- XmlParse
- XmlSearch
- XmlTransform
- XmlValidate
- Year
- YesNoFormat
- ColdFusion Tags
- ColdFusion tag summary
- ColdFusion tags by category
- Application framework tags
- Communications tags
- Database manipulation tags
- Data output tags
- Debugging tags
- Exception handling tags
- Extensibility tags
- File management tags
- Flow-control tags
- Forms tags
- Internet Protocol tags
- Page processing tags
- Security tags
- Variable manipulation tags
- Other tags
- Tags a-b
- Tags c
- Tags f
- cffeed
- cffile
- cffile action = "append"
- cffile action = "copy"
- cffile action = "delete"
- cffile action = "move"
- cffile action = "read"
- cffile action = "readBinary"
- cffile action = "rename"
- cffile action = "upload"
- cffile action = "uploadAll"
- cffile action = "write"
- cffileupload
- cffinally
- cfflush
- cfform
- cfformgroup
- cfformitem
- cfftp
- cfftp: Connection: file and directory operations
- cfftp: Opening and closing FTP server connections
- cfftp : Opening and closing secure FTP server connections
- cfftp action = "listDir"
- cffunction
- Tags g-h
- Tags i
- Tags j-l
- cfjava
- cflayout
- cflayoutarea
- cfldap
- cflocation
- cflock
- cflog
- cflogin
- cfloginuser
- cflogout
- cfloop
- cfloop : conditional loop
- cfloop : index loop
- cfloop : looping over a COM collection or structure
- cfloop : looping over a date or time range
- cfloop : looping over a list, a file, or an array
- cfloop : looping over a query
- Tags m-o
- cfmail
- cfmailparam
- cfmailpart
- cfmap
- cfmapitem
- cfmediaplayer
- cfmenu
- cfmenuitem
- cfmessagebox
- cfmodule
- cfNTauthenticate
- cfoauth
- cfobject
- cfobject: .NET object
- cfobject: COM object
- cfobject: component object
- cfobject: CORBA object
- cfobject: Java or EJB object
- cfobject: web service object
- cfobjectcache
- cfoutput
- Tags p-q
- Tags r-s
- Tags t
- Tags u-z
- CFML Reference
- Reserved words and variables
- Ajax JavaScript functions
- Ajax JavaScript functions
- Function summary Ajax
- ColdFusion.Ajax.submitForm
- ColdFusion.Autosuggest.getAutosuggestObject
- ColdFusion.Layout.enableSourceBind
- ColdFusion.MessageBox.getMessageBoxObject
- ColdFusion.ProgressBar.getProgressBarObject
- ColdFusion.MessageBox.isMessageBoxDefined
- JavaScriptFunctionsinColdFusion9Update1
- ColdFusion ActionScript functions
- ColdFusion mobile functions
- Application.cfc reference
- Script functions implemented as CFCs
- ColdFusion Flash Form style reference
- Styles valid for all controls
- Styles for cfform
- Styles for cfformgroup with horizontal or vertical type attributes
- Styles for box-style cfformgroup elements
- Styles for cfformgroup with accordion type attribute
- Styles for cfformgroup with tabnavigator type attribute
- Styles for cfformitem with hrule or vrule type attributes
- Styles for cfinput with radio, checkbox, button, image, or submit type attributes
- Styles for cftextarea tag and cfinput with text, password, or hidden type attributes
- Styles for cfselect with size attribute value of 1
- Styles for cfselect with size attribute value greater than 1
- Styles for cfcalendar tag and cfinput with dateField type attribute
- Styles for the cfgrid tag
- Styles for the cftree tag
- ColdFusion Flash Form Style Reference
- ColdFusion event gateway reference
- ColdFusion Event Gateway reference
- addEvent
- CFEvent
- CFEventclass
- Constructor
- Gateway development interfaces and classes
- getStatus
- setCFCPath
- setCFCMethod
- getOriginatorID
- getLogger
- getBuddyList
- getBuddyInfo
- IM gateway message sending commands
- IM Gateway GatewayHelper class methods
- onIncomingMessage
- onIMServerMessage
- onBuddyStatus
- onAddBuddyResponse
- onAddBuddyRequest
- IM Gateway CFC incoming message methods
- IM gateway methods and commands
- CFML CFEvent structure
- warn
- info
- setOriginatorID
- data command
- submit Multi command
- submit command
- setGatewayType
- setGatewayID
- setData
- setCFCListeners
- outgoingMessage
- getStatusTimeStamp
- numberOfMessagesReceived
- numberOfMessagesSent
- removeBuddy
- removeDeny
- removePermit
- setNickName
- setPermitMode
- setStatus
- SMS Gateway CFEvent structure and commands
- SMS Gateway incoming message CFEvent structure
- getStatusAsString
- getProtocolName
- getPermitMode
- getPermitList
- getNickName
- getName
- getDenyList
- getCustomAwayMessage
- getQueueSize
- getMaxQueueSize
- getHelper
- getGatewayType
- getGatewayServices
- getGatewayID_1
- getGatewayID
- getData
- getCFCTimeout
- setCFCTimeout
- getCFCPath
- getCFCMethod
- GatewayServices class
- Gateway interface
- GatewayHelper interface
- addPermit
- addDeny
- addBuddy
- error
- debug
- Logger class
- stop
- start
- CFML event gateway SendGatewayMessage data parameter
- restart
- fatal
- SMS gateway message sending commands
- ColdFusion C++ CFX Reference
- ColdFusion Java CFX reference
- WDDX JavaScript Objects
- Cloud services
- ColdFusion and GCP Storage
- ColdFusion and GCP Firestore
- ColdFusion and GCP PubSub
- ColdFusion and Amazon S3
- ColdFusion and DynamoDB
- ColdFusion and Amazon SQS
- ColdFusion and Amazon SNS
- ColdFusion and MongoDB
- ColdFusion and Azure Blob
- ColdFusion and Azure Service Bus
- Multi-cloud storage services
- Multi-cloud RDS databases
- ColdFusion and Azure Cosmos DB
Use the cfpdf tag to read an existing PDF, write meta-data to it, merge PDFs together, delete pages, create thumbnails of the pages, extract text and images, add or remove watermarks, electronically sign or unsign documents, sanitize and redact PDF contents for better security, and safeguard the PDFs with a password.
Description
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 to generate flat PDF documents.
- Encrypt and add password protection to PDF documents.
- Generate thumbnail images from PDF documents or pages.
- 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
History
New actions for <cfpdf> tag in ColdFusion 2016:
ColdFusion 11 has added the following new attributes to the <cfpdf> tag:
- keystore
- keystorepassword
- keyalias
- keypassword
- author
- signaturefieldname
- unsignall
- height
- width
ColdFusion 8: Added this tag.ColdFusion 9: Added new attributes: jpgdpi, maxBreadth, noAttachments, leftMargin, algo, noMetadata, noBookMarks,
noJavaScripts, useStructure, noFonts
The license could not be verified: License Certificate has expired!
The tag does not support variables for some attributes. For example,
Incorrect: <cfpdf action="export" type="comment" source="samplePDFVariable" />
Correct: <cfpdf action="export" type="comment" source="c:\source.pdf" exportto="c:\destination.pdf" />
Category
Syntax
Add a watermark to a PDF document <cfpdf required action = "addwatermark" source = "absolute or relative pathname to a PDF file|PDF document variable| cfdocument variable" one of the following: copyfrom = "absolute or relative pathname to a PDF file from which the first page is used as a watermark" image = "absolute or relative pathname to image file|image variable used as a watermark" optional foreground = "yes|no" isBase64 = "yes|no" opacity = "watermark opacity" overwrite = "yes|no" pages = "page or pages to add the watermark" password = "user or owner password for the PDF source file" position = "position on the page where the watermark is placed" rotation = "degree of rotation of the watermark" showonprint = "yes|no"> // one of the following: destination = "PDF output file pathname" name = "PDF document variable name" image = "image file name to be used as the footer" text = "text to be used in the footer" <!--- action=sanitize ---> <cfpdf // required action="sanitize" source = "absolute or relative pathname to a PDF file|PDF document variable|cfdocument variable" // Use any one of the following attributes: destination = "PDF output file pathname" name = “PDF document variable name”> <!--- end syntax ---> <!--- action=export comments ---> <cfpdf // required action="export" type="comment" source = "absolute or relative pathname to a PDF file|PDF document variable|cfdocument variable" exportTo = "destination of xfdf file"> <!--- end syntax ---> <!--- action=import comments ---> <cfpdf // required action="import" type="comment" source = "absolute or relative pathname to a PDF file|PDF document variable|cfdocument variable" importFrom = "source of xfdf file" // Use any one of the following attributes: destination = "PDF output file pathname" name = “PDF document variable name”> <!--- end syntax ---> <!--- action=export metadata ---> <cfpdf // required action="export" type="metadata" source = "absolute or relative pathname to a PDF file|PDF document variable|cfdocument variable" exportTo = "destination of xmp file"> <!--- end syntax ---> <!--- action=import metadata ---> <cfpdf // required action="import" type="metadata" source = "absolute or relative pathname to a PDF file|PDF document variable|cfdocument variable" importFrom = "source of xmp file" // Use any one of the following attributes: destination = "PDF output file pathname" name = “PDF document variable name”> <!--- end syntax ---> <!--- action=archive ---> <cfpdf // required action="archive" source="#sourcefilename#" // Use any one of the following attributes: destination = "PDF output file pathname" name = “PDF document variable name”> // optional standard = "3b"/> <!--- end syntax ---> <!--- action=addAttachments ---> <cfpdf // required action="addAttachments" source = "absolute or relative pathname to a PDF file|PDF document variable|cfdocument variable|directory path" // Use any one of the following attributes: destination = "PDF output file pathname" name = “PDF document variable name” <cfpdfparam // required source= "path of attachment" filename = "filename for the attachment" encoding = "encoding for filename" > // optional description = "descriptive text" mimetype = "eg: application/pdf, text/html"> > <!--- end syntax ---> <!--- action=addStamp ---> <cfpdf // required action="addStamp" source = "absolute or relative pathname to a PDF file|PDF document variable|cfdocument variable" // Use any one of the following attributes: destination = "PDF output file pathname" name = “PDF document variable name”> <cfpdfparam pages = "page number|page range|comma-separated page numbers" <!--- It is recommended that that ratio of the stamp width:height is 10:3 ---> coordinates = "llx,lly,urx,ury" iconName = "name of icon" note = "content of stamp" > > <!--- end syntax ---> Add headers <cfpdf required action = "addheader" source = "absolute or relative pathname to a PDF file|PDF document variable| cfdocument variable" pages = "page or pages to add the footer" optional isBase64 = "yes|no" overwrite = "yes|no" password = "user or owner password for the PDF source file" showonprint = "yes|no"> align = "left|right|center" leftmargin = "value of the header left marign" rightmargin = "value of the header right margin" numberformat = "LOWERCASEROMAN|NUMERIC|UPPERCASEROMAN" <!---used with either _PAGENUMBER or _LASTPAGENUMBER---> opacity = "header opacity" topmargin = "value of the top margin of the header" \\one of the following: destination = "PDF output file pathname" name = "PDF document variable name" text = _PAGELABEL: add current page label|_LASTPAGELABEL: add last page label| _PAGENUMBER: add current page number|_LASTPAGENUMBER: add last page number \\text for the header. You can also add a normal text string. image = "image file name to be used as the header" Add footer <cfpdf required action = "addfooter" source = "absolute or relative pathname to a PDF file|PDF document variable| cfdocument variable" pages = "page or pages to add the footer" optional isBase64 = "yes|no" overwrite = "yes|no" password = "user or owner password for the PDF source file" showonprint = "yes|no"> destination = "PDF output file pathname" name = "PDF document variable name" align = "left|right|center" one of the following: image = "image file name to be used as the footer" text = _PAGELABEL: add current page label|_LASTPAGELABEL: add last page label| _PAGENUMBER: add current page number|_LASTPAGENUMBER: add last page number \\text for the header leftmargin = "value of the footer left marign" rightmargin = "value of the footer right margin" numberformat opacity = "footer opacity" bottommargin = "value of the bottom margin" Delete pages from a PDF document <cfpdf required action = "deletepages" pages = "page or pages to delete" source = "absolute or relative pathname to a PDF file|PDF document variable| cfdocument variable" optional overwrite = "yes|no" password = "PDF source file password" one of the following: destination = "PDF output file pathname" name = "PDF document variable name"> Delete headers and footers <cfpdf required action = "removeheaderfooter" source = "absolute or relative pathname to a PDF file|PDF document variable| cfdocument variable" optional overwrite = "yes|no" pages = "page or pages to add the watermark" password = "user or owner password for the PDF source file" one of the following: destination = "PDF output file pathname" name = "PDF document variable name" Retrieve information about a PDF document <cfpdf required action = "getinfo" name = "structure variable name" source = "absolute or relative pathname to a PDF file|PDF document variable| cfdocument variable" optional password = "PDF source file password"> Merge PDF documents into an output PDF file <cfpdf required action = "merge" one of the following: directory = "directory of PDF files to merge" source = "comma-separated list of PDF source files|absolute or relative pathname to a PDF file|PDF document variable|cfdocument variable" <cfpdfparam> \\required only when package is specified as true order = "name|time" one of the following if <cfpdfparam> is specified: name = "PDF document variable name" destination = "PDF output file pathname" optional package = "true|false" <!---create PDF packages if set to true. You can provide description in cfpdfparam tag, such as <cfpdfparam file="filename desc="">---> ascending = "yes|no" keepBookmark = "yes|no" overwrite = "yes|no" pages = "pages to merge in PDF source file" password = "PDF source file password" stopOnError = "yes|no" \\one of the following: destination = "PDF output file pathname" name = "PDF document variable name"> Use DDX instructions to manipulate PDF documents <cfpdf required ddxfile = "DDX filepath|DDX string" inputfiles = "#inputStruct#" outputfiles = "#outputStruct#" name = "structure name"> optional action="processddx" Set passwords and encrypt PDF documnets <cfpdf required action = "protect" source = "absolute or relative pathname to a PDF file|PDF document variable| cfdocument variable" at least one of the following: newUserPassword = "password" newOwnerPassword = "password" if newOwnerPassword is specified: permissions = "All|AllowAssembly|AllowDegradedPrinting|AllowCopy|AllowFillIn| AllowModifyAnnotations| AllowModifyContents|AllowPrinting|AllowScreenReaders|AllowSecure|None| comma-separated list" optional destination = "PDF output file pathname" encrypt = "RC4_40|RC4_128|RC4_128M|AES_128|AES_256R6|AES_256R5|none" overwrite = "yes|no" password = "source file password"> Name a PDF document variable <cfpdf required action = "read" name = "PDF document variable name" source = "absolute or relative pathname to a PDF file|PDF document variable| cfdocument variable" optional password = "PDF source file password"> Remove a watermark from a PDF document <cfpdf required action = "removeWatermark" source = "absolute or relative pathname to a PDF file|PDF document variable| cfdocument variable" optional overwrite = "yes|no" pages = "page or pages from which to remove the watermark" password = "PDF source file password"> one of the following: destination = "PDF output file pathname" name = "PDF document variable name" Set information about a PDF document <cfpdf required action = "setinfo" info = "#structure variable name#" source = "absolute or relative pathname to a PDF file|PDF document variable| cfdocument variable" optional destination = "PDF output file pathname" overwrite = "yes|no" password = "PDF source file password"> Generate thumbnails from pages in a PDF document <cfpdf required action = "thumbnail" source = "absolute or relative pathname to a PDF file|PDF document variable| cfdocument variable" optional destination = "directory path where the thumbnail images are written" format = "png|jpeg|tiff" imagePrefix = "string used as a prefix in the output filename" overwrite = "yes|no" password = "PDF source file password"> pages = "page or pages to make into thumbnails" resolution= "low|high" scale = "percentage between 1 and 100" transparent = "yes|no"> hires = "yes|no" overridepage = "yes|no" compresstiffs = "yes|no" maxscale = "maximum scale of the thumbnail" maxlength = "maximum length of the thumbnail" maxbreadth = "maximum width of the thumbnail" jpgdpi = "sets the dpi (dots per inch) value of the jpeg image. The default value is 96 dpi." Write a PDF document to an output file <cfpdf required action = "write" source = "absolute or relative pathname to a PDF file|PDF document variable| cfdocument variable" \\one of the following destination = "PDF output file pathname" name = #PDF variable# <!---new variable support added now---> optional flatten = "yes|no" overwrite = "yes|no" password = "PDF source file password" saveOption = "linear|incremental|full" version = "1.1|1.2|1.3|1.4|1.5|1.6"> encodeall = "yes|no" Reduce the quality of a PDF document <cfpdf required action = "optimize" source = "absolute or relative path of the PDF file|PDF document variable| cfdocument variable" algo = "bilinear|bicubic|nearest_neighbour" <!---algorithm for image downsampling---> pages = "*" <!----page numbers associated with the objects in the PDF document---> optional vscale= "Vertical scale of the image to be modified. Valid values are vscale>0" hscacle="Horizontal scale of the image to be modified. Valid values are hscale<1" destination = "PDF output file pathname" name = "PDF document variable" noattachments = "Discard all attachments" nobookmarks = "Discard all bookmarks" nocomments = "Discard all comments" nofonts = "Discard all fonts" nojavascripts = "Discard all JavaScript actions" nolinks = "Discard external cross-references" nometadata = "Discard document information and metadata" nothumbnails = "Discard embedded page thumbnails" overwrite = "true" <!---Overwrite the specified object in the PDF document---> password = "" <!--- PDF document password---> Extract text <cfpdf required action="extracttext" <!---extract all the words in the PDF.---> source= "absolute or relative path of the PDF file|PDF document variable| cfdocument variable" pages = "*" <!----page numbers from where the text needs to be extracted from the PDF document---> optional addquads = "add the position or quadrants for the text in the PDF" honourspaces = "true|false" overwrite = "true" <!---Overwrite the specified object in the PDF document---> password = "" <!--- PDF document password---> type = "string|xml" <!---format in which the text needs to be extracted---> one of the following: destination = "PDF output file pathname" name = "PDF document variable" usestructure = "true|false" Extract image <cfpdf required action = "extractimage" <!---extract images and save it to a directory---> source = "absolute or relative path of the PDF file|PDF document variable| cfdocument variable" pages = "*" <!---page numbers from where the images need to be extracted---> optional overwrite = "true|false" <!---overwrite any existing image when set to true---> format = "png|tiff|jpg" <!---format in which the images should be extracted---> imageprefix = "*" <!---the string that you want to prefix with the image name---> password = "" <!--- PDF document password---> destination = "PDF output file pathname" Page level transformations <cfpdf required action = "transform" source = "absolute or relative path of the PDF file|PDF document variable| cfdocument variable" pages = "page or pages to be transformed" optional hscale = "value of the horizontal scale of the page" overwrite = "yes|no" password = "PDF source file password" position = "x, y" <!---value in pixels---> rotation = "0|90|180|270" vscale = "length of the page to be transformed" one of the following: destination = ""Path of the directory where the PDF document will be saved" name = "PDF document variable" // redact <cfpdf action="redact" source="source PDF document" destination="destination PDF document" overwrite="true | false"> <cfpdfparam pages="from page-to page" coordinates="llx,lly,urx,ury"> </cfpdf>
You can specify this tag's attributes in an attributeCollection attribute whose value is a structure. Specify the structure name in the attributeCollection attribute and use the tag's attribute names as structure keys.
See also
cfdocument, cfdocumentsection, cfpdfform, cfpdfformparam, cfpdfparam, cfpdfsubform, cfprint, IsDDX, IsPDFFile,
IsPDFObject, Assembling PDF Documents in the Developing ColdFusion Applications
Attributes
Attribute |
Action |
Req/Opt |
Description |
---|---|---|---|
action |
N/A |
Optional |
Action to take: archive addAttachments addStamp addWatermark deletePages export getInfo import merge processddx protect read removeWatermark sanitize setInfo sign thumbnail write optimize extracttext extractimage addheader addfooter removeheaderfooter transform unsign validatesignature New in ColdFusion 11–Validates all the signatures
readsignaturefields New in ColdFusion 11–Reads all the signature fields and returns a query object in the variable
New in ColdFusion 2016:
|
addquads |
extracttext |
Optional |
Add the position or quadrants of the thumbnail |
align |
addheader |
Optional |
Aligns the header and footer in PDF. |
algo |
optimize |
Required |
Specifies the algorithm for image downsampling. The values are bilinear, bicubic, and nearest_neighbour |
ascending |
merge |
Optional |
Order in which the PDF files are sorted: yes: Files are sorted in ascending order no: Files are sorted in descending order |
author |
sign |
Optional |
Business transactions, including financial, legal, and other Verify document authenticity – confirm the identity of person who signed the document Verify document integrity – Author-based signatures provide both of these security services. If attribute is not mentioned |
bottomMargin |
addfooter |
Optional |
Specifies the value of the bottomMargin |
copyFrom |
addWatermark |
Optional |
Pathname of the PDF document from which to use the first page as a watermark |
compresstiffs |
thumbnail |
Optional |
Compress thumbnail which are in TIFF format. |
ddxfile |
processddx |
Required |
Pathname of the DDX file, or a string with DDX instructions |
destination |
addWatermark archive
|
Required for |
Pathname of the modified PDF document. If the destination file exists, set the overwrite attribute to yes. |
directory |
merge |
Optional |
Directory of the PDF documents to merge. Specify either the directory attribute or the source attribute. If you specify the directory attribute, ColdFusion orders the documents by filename in descending order, by default. To change the order of the files, use the order attribute. |
encodeall |
write |
Optional |
Encode streams that are not encoded to optimize page content |
protect |
Optional |
Encryption type for the PDF output file. In ColdFusion 2016, there is support for two new encryption algorithms, AES_256R6 and AES_256R5.
Note: The JRE must have "Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy Files" installed. This is only required for the new encryption algorithms. For more information, see the section Encryption for PDF documents. |
|
flatten |
write |
Optional |
Applies to forms created in Acrobat only (not forms created in LiveCycle); specifies whether interactivity is turned off: yes: the form fields are no longer interactive. no: the form fields remain interactive. |
foreground |
addWatermark |
Optional |
Placement of the watermark on the page: yes: the watermark appears in the foreground (over the page content). no: the watermark appears in the background (behind the page content). |
format |
thumbnail |
Optional |
File type of thumbnail image output: jpg tiff png |
hires |
thumbnail |
optional |
Sets a high resolution for the thumbnail if set to yes. |
height |
sign |
Optional |
Height of the signature field. |
honourspaces |
extracttext |
optional |
Set this option to "true", for improved readability and spacing. |
hscale |
optimize |
optional |
Horizontal scale of the image to be modified. Valid values are hscale<1. |
image |
addWatermark |
Optional |
Image used as a watermark. You can specify a pathname, a variable that contains an image file, or a ColdFusion image variable. |
imagePrefix |
thumbnail |
Optional |
Prefix used for each image thumbnail file generated. The image filenames use the format: imagePrefixpagen.format. For example, the thumbnail for page 1 of a document with the imagePrefix attribute set to myThumbnail is myThumbnail_page_1.jpg. |
info |
setInfo |
Required |
Structure variable for relevant information, for example, " #infoStruct#" . You can specify the Author, Subject, Title, and Keywords for the PDF output file. |
inputFiles |
processddx |
Required |
Structure that maps the PDF source files to the input variables in the DDX file, or a string of elements and their pathname. |
isBase64 |
addWatermark |
Optional |
Valid only when the image attribute is specified. Specifies whether the image used as a watermark is in Base64 format: yes: the image is in Base64 format. no: the image is not in Base64 format. |
jpgdpi |
addThumbnail |
Optional |
Sets the DPI of the jpeg image. Default is 96 dpi. |
keepBookmark |
merge |
Optional |
Specifies whether bookmarks from the source PDF documents are retained in the merged document: yes: the bookmarks are retained. no: the bookmarks are removed. |
keyalias |
sign |
Optional |
Alias of the key with which the certificate and private key are stored in the keystore . If it is not specified, the first entry in the keystore is chosen as the alias. |
keystore |
sign |
Required |
The |
keypassword |
sign |
Optional |
Password for your private key. If not specified the keystorepassword is used. |
keystorepassword |
sign |
Required |
The password of the keystore . |
leftmargin |
addheader |
Optional |
Specifies the value of the header left margin |
maxbreadth |
thumbnail |
Optional |
Specifies maximum width of the thumbnail |
maxlength |
thumbnail |
Optional |
Specifies the maximum length of the thumbnail |
maxscale |
thumbnail |
Optional |
Specifies the maximum scale of the thumbnail |
name |
addWatermark |
Required: |
PDF document variable name, for example, myBook. For the readsignaturefields action, the name represents the structure thats is populated with the info of all the signature fields in the source PDF document.
|
newOwner |
protect |
Optional (see Description) |
Password used to set permissions on a PDF document. |
newUser |
protect |
Optional (see Description) |
Password used to open PDF document.Specify either the newUserPassword attribute or a newOwnerPassword attribute; if you specify both, the passwords must differ. For more information, see the section PDF document passwords. |
noattachments |
thumbnail |
Optional |
Removes all attachments from PDF documents. |
noattachments |
optimize |
Optional |
Remove all file attachments |
nobookmarks |
optimize |
Optional |
Remove bookmarks from PDF document |
nocomments |
optimize |
Optional |
Remove comments from PDF document |
nofonts |
optimize |
Optional |
Remove font styling |
nojavascripts |
optimize |
Optional |
Remove all document level JavaScript actions |
nolinks |
optimize |
Optional |
Remove external cross-references |
nometadata |
optimize |
Optional |
Remove document information and metadata |
nothumbnails |
optimize |
Optional |
Remove embedded page thumbnails |
numberformat |
addfooter |
Optional |
Specify the numbering format for PDF pages in the footer. |
opacity |
addWatermark |
Optional |
Opacity of the watermark. Valid values are integers in the range 0 (transparent) through 10 (opaque). |
order |
merge |
Optional |
Order in which the PDF documents in the directory are merged: name: orders the documents alphabetically by filename. time: orders the documents by timestamp. |
outputFiles |
processddx |
Required |
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 |
addSign addWatermark |
Optional |
Specifies whether PDF output overwrites the destination file: yes: overwrites the destination file. no: does not overwrite the destination file. |
package |
merge |
Optional |
Create PDF packages |
pages |
addWatermark |
Required: |
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 |
addWatermark addSign |
Optional |
Owner or user password of the source PDF document, if the document is password-protected. |
permissions |
protect |
Optional |
Type of permissions All AllowAssembly AllowCopy AllowDegradedPrinting AllowFillIn AllowModifyAnnotations AllowModifyContents AllowPrinting AllowScreenReaders AllowSecure None |
position |
addWatermark sign |
Optional |
The position attribute is the coordinate of the lower left corner of the signature field. |
resolution |
thumbnail |
Optional |
Image quality used to generate thumbnail images: high: use high resolution low: use low resolution. |
rotation |
addWatermark |
Optional |
Degree of rotation of the watermark image on the page, for example, "30". |
saveOption |
write |
Optional |
Save options for the PDF output: full: normal save (default) incremental: required to save modifications to a signed PDF document. linear: for faster display. |
scale |
thumbnail |
Optional |
Size of the thumbnail relative to the source page. The value represents a percentage from 1 through 100. |
showOnPrint |
addWatermark |
Optional |
Specify whether to print the watermark with the PDF document: yes: the watermark is printed with the PDF document. no: the watermark is display-only. |
signature |
sign unsign |
Optional |
Name of signature field in which the user wants to sign or the name of the signature field that the user wants to unsign. |
source |
archive addWatermark |
Required (see |
PDF document used as the source. The source can be one of the following: An absolute or relative pathname to a PDF document, for example, c:\work\myPDF.pdf or myPDF.pdf. A PDF document variable in memory that is generated by the cfdocument tag or the cfpdf tag, for example, " myPDFdoc". |
stopOnError |
merge |
Optional |
Valid only if the directory attribute is specified. If the specified directory contains files other than 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. |
transparent |
thumbnail |
Optional |
(format="png" only) Specifies whether the image background is transparent or opaque: yes: the background is transparent. no: the background is opaque. |
unsignall |
unsign |
Optional |
Unsigns all the signatures in the document. |
useStructure |
extracttext |
Optional |
Let's you extract content based on the PDF structure. For better readability of the extracted text, use this attribute together with the attribute honourspaces . |
version |
write |
Optional |
Version of the PDF 1.1 1.2 1.3 1.4 1.5 1.6 |
width |
sign |
optional |
Width of the signature field.
|
To modify the PDF source document, specify the same file pathname for the source and destination attributes, and set the overwrite attribute to yes.
Archiving a signed PDF created using ColdFusion behaves abnormally when opened using Adobe Acrobat. To fix the document for archiving enable the "Changing the Document" permission under the Security options of Acrobat.
Usage
You use the cfpdf tag to manipulate and assemble existing PDF documents. Although the cfpdf tag provides much of the functionality available in Acrobat, you cannot use this tag to generate a PDF document from another file format. To create PDF output from HTML and CFML content, use the cfdocument tag.
You cannot embed a cfpdf tag within a cfdocument tag or embed a cfdocument tag within a cfdpdf tag; however, you can write the output of a cfdocument tag to a variable and pass the variable to the cfpdf tag. The following example shows how to use the cfdocument tag to create a cover page and add it to a merged PDF document:
<!--- Use the cfdocument tag to create a cover page and write the output to a variable called cfdoc. ---> <cfdocument format="PDF" name="cfdoc"> <html> <body> <h1>Here is a cover page</h1> </body> </html> </cfdocument> <!--- Use the cfpdf tag and cfpdfparam tags to merge individual PDF documents into a new PDF document called new.pdf. Notice that the cfdoc variable created by using the cfdocument tag is the source value of the first cfpdfparam tag. ---> <cfpdf action="merge" destination="/samtemp/pdfs/new.pdf" overwrite="yes"> <cfpdfparam source="cfdoc"> <cfpdfparam source="/samtemp/pdfs/pdf2.pdf"> <cfpdfparam source="/samtemp/pdfs/pdf1.pdf"> </cfpdf>
You can use the cfpdf tag to assemble interactive PDF form files into a single PDF document and flatten forms created in Acrobat (by using the flatten attribute with the write action); however, to process PDF form data, use the cfpdfform and related tags. You cannot use the cfpdf tag to flatten forms created in Adobe LiveCycle Designer ES.
Reading and writing PDF files
The cfpdf tag provides several options for reading and writing PDF files. You can specify a PDF variable or a PDF file as the source, and you can write the output to a variable or to a file (but not both). The following table explains the read and write operations:
Task |
Attributes |
Example |
---|---|---|
Overwrite a source PDF file |
Specify the PDF file pathname as the source and do not specify a destination. |
<cfpdf action="addWatermark" source="myPDF.pdf" image="myImage.jpg"> |
Write a PDF document in memory to a file |
Specify the PDF variable as the source and a PDF file pathname for the destination. |
<cfpdf action="addWatermark" source="myPDF" image="myImage.jpg" destination="outputFile.pdf"> |
Write a PDF document to a new file |
Specify a PDF file pathname as the source and a different PDF file pathname as the destination. |
<cfpdf action="addWatermark" source="sourceFile.pdf" image="myImage.jpg" destination="outputFile.pdf"> |
Write a PDF file to a PDF variable |
Specify the PDF file pathname as the source and a PDF variable name. |
<cfpdf action="addWatermark" source="sourceFile.pdf" image="myImage.jpg" name="myPDF"> |
Overwrite a PDF document in memory |
Specify the PDF variable name as the source and do not specify a destination. |
<cfpdf action="addWatermark" source="myPDF" image="myImage.jpg"> |
Working with PDF files in memory
ColdFusion gives you the option to write a PDF file to a variable by using the name attribute, which is useful if you want to perform multiple operations on a document before writing it to a file. However, this is practical for small files only because of memory requirements. If you are working with large PDF documents, write the PDF documents to files.ColdFusion recommends that you do not specify the name attribute when you specify a variable as the source because it creates a copy, which increases processing. In most cases, this is unnecessary because you can reuse variables even after you write them to files.
When you use PDF variables within a try/catch block and ColdFusion generates an error, the variables are unusable after the error is generated.
Printing PDF documents
Use the cfprint tag to print PDF documents. Markups, such as sticky notes, comments, and editorial revisions, are not printed with the document.
- addWatermark action Use the addwatermarkaction to add a watermark to specified pages in a PDF document. You can add a watermark in one of the following ways:
- Use the first page of another PDF document as a watermark. ColdFusion overlays the copyfrom page on the source document, without enlarging the image.
- Specify an image file to use as a watermark.
Specify an image in memory by using an image variable.
The following code shows how to use the first page of a PDF document as a watermark:
<cfpdf action="addWatermark" source="c:\myBook.pdf" copyFrom="e:\yourBook.pdf" destination="ourBook.pdf" overwrite="yes">
By default, ColdFusion applies the watermark to all of the pages in the output file, with the watermark image centered on the page. The following code applies a JPEG image as a watermark to the first page of the output file:
<cfpdf action="addWatermark" source="Book.pdf" image="../cfdocs/images/artgallery/paul01.jpg" destination="newBook.pdf" pages="1" overwrite="yes">
To specify a ColdFusion image as a watermark, use the cfimage tag or Image functions. The addwatermark action also supports RGB and ARGB images, especially the images added using the cfimagetag and related functions. The following example converts an image to grayscale and applies it as a watermark to a PDF file:
<!--- Use the ImageNew function to create a ColdFusion image from a JPEG file. ---> <cfset myImage=ImageNew("../cfdocs/images/artgallery/jeff05.jpg")> <!--- Use the ImageGrayscale function to convert the image to grayscale in memory. ---> <cfset ImageGrayscale(myImage)> <!--- Specify the image variable to apply the grayscale image as a watermark in the Book.pdf file. Because the source and destination are the same and the overwrite attribute is set to yes, ColdFusion overwrites the source file. ---> <cfpdf action="addWatermark" source="Book.pdf" destination="Book.pdf" overwrite="yes" image="#myImage#">
For more information on ColdFusion images, see Creating and Manipulating ColdFusion Images in the Developing ColdFusion Applications.
addfooterUse this action to add a footer in a PDF document. Specify the source where the PDF document is located and the destination where the new PDF document with the footer is saved, as shown in the following code snippet:
<cfpdf action = "addfooter" source = "../myBook.pdf" destination = "../myBookwithfooter.pdf" image = "adobelogo.JPG" // Use this attribute to add an image in the footer align = "right"> // By default, the alignemnt is center
You can also specify an image or text that you have to insert in the footer along with various other attributes such as align, bottommargin, leftmargin, numberformat, and opacity.
addheaderUse this action to add header in a PDF document. Specify the source and destination for the PDF document and specify the text or image that you want to insert in the header, as shown in the following code:
<cfpdf action = "addheader" source = "../myBook.pdf" destination = "../myBookwithheader.pdf" text = "Adobe" align = "left">
- deletePages action Use the deletePagesaction to remove pages from a specified PDF document. You can specify a single page, a page range, or a comma-separated list of pages, as the following code shows:
<cfpdf action="deletePages" source="c:\myBook.pdf" pages="1,16-32,89,100-147" destination="myLittleBook.pdf">
- extracttext Use the extracttextaction to extract all words from the specified page numbers in the PDF document, as shown in the following code snippet:
<cfpdf action = "extracttext" source = "../myBook.pdf" pages = "5-20, 29, 80" destination = "../adobe/textdoc.txt"
- extractimage Use the extractimage action to extract all images from the specified page number in a PDF document, as shown in the following code snippet:
<cfpdf action = "extractimage" source = "../myBook.pdf" pages = "1-200" destination = "..\mybookimages" imageprefix = "mybook">
The images are extracted and saved in the directory that you specify in the destination attribute. You can specify a prefix for the images (imageprefix) being extracted, otherwise the system prefixes the i
on to extract information associated with the PDF document, such as the author, title, and creation date. You specify the name of the structure variable that contains the relevant data associated with the file, as the following code shows:
<cfpdf action="getInfo" source="myBook.pdf" name="PDFInfo"> <p><cfoutput>#PDFInfo.title#</cfoutput></p> <p><cfoutput>#PDFInfo.author#</cfoutput></p> <p><cfoutput>#PDFInfo.keywords#</cfoutput></p> <p><cfoutput>#PDFInfo.created#</cfoutput></p>
For a complete list of information elements, use the cfdumptag, as the following code shows:
<cfdump var="#PDFInfo#">
To view the permissions for a PDF document that is password-protected, specify the user password, not the owner password. If you specify the owner password, all permissions are set to Allowed.
Reducing quality of PDF document
The optimize action is used to downsample images and discard unused objects in a PDF document.
optimize To downsample images in a PDF document, the algos attribute is used with values bilinear, bicubic, and nearest_neighbour. The following code snippet generates a PDF after image downsampling:
<cfpdf action = "optimize" algo = "bicubic" source "..\myBook.pdf" name = #mybook#>
You can also discard unused objects such as comments, JavaScripts, attachments, bookmarks, and metadata from your PDF document using the following attributes with optimize action:
<cfpdf action = "optimize" noJavaScripts noThumbnails noBookmarks noComments noMetadata noFileAttachments noLinks nofonts>
Transforming pages in a PDF document
You can scale a page, specify the position, and rotation values for pages in a PDF document.
transform The transform action has four attributes that define the size (hscale, vscale), position(position), and rotation (rotation) of a page. The following code snippet shows the usage:
<cfpdf action = "transform" required source = "..\myBook.pdf" optional destination = "..\new\myBook.pdf"> hscale = ".5" vscale = ".15" position = "8, 10" rotation = "180">
The value for rotation must be in steps (0, 90, 180, 270). If you specify any other value, the system generates an error.
PDF file information elements
The following table describes the information elements you can retrieve with the getinfo action:
Element |
Example |
Description |
---|---|---|
Application |
Acrobat PDFMaker 7.0.7 for Word |
Application used to create the PDF document. This value is read-only. |
Author |
Harper Lee |
Author of the PDF document. You can specify a text string with the setInfo action. |
CenterWindowOnScreen |
empty string |
Display setting for initial view of the PDF document. To change this setting, use the processddx action with the InitialViewProfile DDX element. |
ChangingDocument |
Not Allowed |
Permissions assigned for editing the PDF content. To change this setting, use the permissions attribute with the protect action. |
Commenting |
Allowed |
Permissions assigned for adding comments to the PDF document. To change this setting, use the permissions attribute with the protect action. |
ContentExtraction |
Allowed |
Permissions assigned for extracting content from the PDF document. To change this setting, use the permissions attribute with the protect action. |
CopyContent |
Allowed |
Permissions assigned for copying content from the PDF document. To change this setting, use the permissions attribute with the protect action. |
Created |
D:20061121155226-05'00' |
System-generated creation date of the PDF document. You can specify a text string with the setInfo action. |
DocumentAssembly |
Not Allowed |
Permissions assigned for merging the PDF document with other PDF documents. To change this setting, use the permissions attribute with the protect action. |
Encryption |
Password Security |
Specifies whether the PDF file is password-protected. To change the encryption algorithm, or add a password, use the protect action. |
FilePath |
C:\ColdFusion\wwwroot\lion\myDoc.pdf |
Absolute pathname for the PDF file. This value is read-only. |
FillingForm |
Allowed |
Permissions assigned for entering data in form fields. To change this setting, use the permissions attribute with the protect action. |
FitToWindow |
empty string |
Display setting for initial view of the PDF document. To change this setting use the processddx action with the InitialViewProfile DDX element. |
HideMenubar |
empty string |
Display setting for initial view of the PDF document. To change this setting, use the processddx action with the InitialViewProfile DDX element. |
HideToolbar |
empty string |
Display setting for initial view of the PDF document. To change this setting, use the processddx action with the InitialViewProfile DDX element. |
HideWindowUI |
empty string |
Display setting for initial view of the PDF document. To change this setting, use the processddx action with the InitialViewProfile DDX element. |
Keywords |
marketing, sales, production |
Keywords specified for searches in the PDF document. You can specify a comma-separated list of keywords with the setInfo action. |
Language |
EN-US |
Language version used to create the source file for the PDF document. This value is read-only. |
Modified |
D:20061121155226-06'00' |
System-generated timestamp for when the PDF file was last modified. You can specify a text string with the setInfo action |
PageLayout |
OneColumn |
Display setting for the initial view of the PDF document. To change this setting, use the processddx action with the InitialViewProfile DDX element. |
Printing |
Allowed |
Permissions assigned for printing the document. To change this setting, use the permissions attribute with the protect action. |
Producer |
Acrobat Distiller 7.0.5 (Windows) |
Version of Acrobat Distiller used to generate the PDF document. This value is read-only. |
Properties |
empty string |
This value is read-only. |
Secure |
Not Allowed |
Display setting that shows whether the PDF document is password protected. |
ShowDocumentsOption |
empty string |
Display setting for initial view of the PDF document. To change this setting, use the processddx action with the InitialViewProfile DDX element. |
ShowWindowsOption |
empty string |
Display setting for initial view of the PDF document. To change this setting, use the processddx action with the InitialViewProfile DDX element. |
Signing |
Allowed |
Permissions for allowing electronic signatures to the PDF document. To change this setting, use the permissions attribute with the protect action. |
Subject |
Product Marketing |
The subject assigned to the PDF document. You can specify a text string with the setInfo action. |
Title |
Chapter 1: Getting Started |
The title assigned to the PDF document. You can specify a text string with the setInfo action. |
TotalPages |
25 |
Total pages in the PDF document. This value is read-only. |
Trapped |
empty string |
Indicates whether trapping is applied to the PDF document. Trapping is used in printing to eliminate gaps between two adjoining ink colors. You can specify a text string with the setInfo action. |
Version |
1.6 |
Version of the Adobe PDF generator used to create the PDF document. To change this setting use the version attribute with the write action. For more information, see the section PDF versions. |
- merge action Use the merge action to assemble PDF documents or pages from PDF source files into one output file. The following code shows how to merge all the PDF files in a directory:
<cfpdf action="merge" directory="c:\myPDFfiles" destination="oneBigFile.pdf" overwrite="yes">
By default, ColdFusion adds the files in descending order by timestamp. The following code merges the source files in ascending order by filename:
<cfpdf action="merge" directory="c:\book" order="name" ascending="yes" destination="c:\book\output1.pdf" overwrite="yes">
This is useful if the source files have logical names, such as Chap0.pdf, Chap1.pdf, Chap2.pdf, and so on.By default, ColdFusion continues the merge process even if it encounters a file in the specified directory that is not a valid PDF document. To stop the merge process if the directory contains files other than valid PDF documents, set the stopOnError attribute to yes:
<cfpdf action="merge" directory="c:\bookfiles" destination="book.pdf" overwrite="yes" order="name" ascending="yes" keepBookmark="yes" stopOnError="yes">
To create a PDF file from specific pages in a document, use the source attribute with the pagesattribute. The following code creates a file from pages 1-5 of the source document:
<cfpdf action="merge" source="myBigBook.pdf" pages="1-5" destination="myShortBook.pdf" overwrite="yes">
To merge several files into one document, specify the absolute pathnames of the files in a comma-separated list, as the following code shows:
<cfpdf action="merge" source="c:\PDFdocs\myBook\Chap1.pdf, c:\PDFdocs\myBook\Chap2.pdf,c:\PDFdocs\myBook\Chap3,pdf" destination="myBook.pdf" package = "true" overwrite="yes">
You can now create PDF packages using the package = "true" attribute with the merge action. For more control over the order of files, to assemble files in different locations, and to extract pages from multiple PDF files, use the cfpdfparam tag with the merge action. For more information on merging PDF files, see Assembling PDF Documents in the Developing ColdFusion Applications.
If cfpdf action="merge" and package="yes", all file formats can be used as source. The following sample code has ZIP and JPEG file formats as source:
<cfpdf action="merge" package="yes" destination="./myBook/adobetest.pdf" overwrite="yes"> <cfpdfparam source="./inputFiles/c.zip" > <cfpdfparam source="./inputFiles/d.jpg" > </cfpdf>
- processddx action Use the proccessddx action to assemble PDF files by processing Document Description XML (DDX) instructions. DDX is a declarative markup language used by Adobe LiveCycle Assembler. You can use DDX instructions to perform advanced tasks, such as adding table of contents pages, headers and footers, automatic page numbers, and text-string watermarks to PDF documents.ColdFusion provides a subset of LiveCycle Assembler functionality. To determine whether you can perform your tasks in ColdFusion or whether you have to purchase LiveCycle Assembler, see the tables in the following sections.
For complete DDX syntax, see the Adobe LiveCycle Assembler Document Description XML Reference.
Supported DDX elements
The following table lists the DDX elements that ColdFusion supports:
About |
Author |
Background |
Center |
DatePattern |
DDX |
DocumentInformation |
DocumentText |
Footer |
Header |
InitialViewProfile |
Keyword |
Keywords |
Left |
MasterPassword |
Metadata |
NoBookmarks |
OpenPassword |
PageLabel |
Password |
PasswordAccessProfile |
PasswordEncryptionProfile |
PDF (see Note) |
PDFGroup |
Permissions |
Right |
StyledText |
StyleProfile |
Subject |
TableOfContents |
TableOfContentsEntryPattern |
TableOfContentsPagePattern |
Title |
Watermark |
|
|
ColdFusion does not support the certification and mergeLayers attributes of the PDF element.
Restricted DDX elements
New in ColdFusion 11 - The following restricted DDX elements are supported in ColdFusion 11 (Enterprise Edition). |
If you are using ColdFusion 10 or earlier, the following DDX elements are excluded by ColdFusion:
ArtBox |
AttachmentAppearance |
Bookmarks |
BlankPage |
BleedBox |
Comments |
Description |
FileAttachments |
FilenameEncoding |
LinkAlias |
Links |
NoBackgrounds |
NoComments |
NoFileAttchments |
NoFooters |
NoForms |
NoHeaders |
NoLinks |
NoPageLabels |
NoThumbnails |
NoWatermarks |
NoXFA |
PageMargins |
PageSize |
PageRotation |
PageOverlay |
PageUnderlay |
PDFsFromBookmarks |
Transform |
TrimBox |
Simple DDX instructions
You can create DDX instructions in any text editor and save the file with a DDX extension. The following example shows the DDX instructions for merging several documents and generating a table of contents with bookmarks from the source PDF documents:
<?xml version="1.0" encoding="UTF-8"?> <DDX xmlns="http://ns.adobe.com/DDX/1.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://ns.adobe.com/DDX/1.0/ coldfusion_ddx.xsd"> <PDF result="Out1"> <PDF source="Title"/> <TableOfContents/> <PDF source="Doc1"/> <PDF source="Doc2"/> <PDF source="Doc3"/> </PDF> </DDX>
Processing DDX instructions in ColdFusion
The following code processes the DDX instructions in ColdFusion:
<!--- The following code verifies that the DDX file exists and the DDX instructions are valid. ---> <cfif IsDDX("Book.ddx")> <!--- The following code maps the PDF source files to the PDF source variables in the DDX file. ---> <cfset inputStruct=StructNew()> <cfset inputStruct.Title="Title.pdf"> <cfset inputStruct.Doc1="Chap1.pdf"> <cfset inputStruct.Doc2="Chap2.pdf"> <cfset inputStruct.Doc3="Chap3.pdf"> <!--- The following code maps the PDF output file to the PDF result variable in the DDX file. ---> <cfset outputStruct=StructNew()> <cfset outputStruct.Out1="output.pdf"> <!--- The following code process the DDX instructions in the Book.ddx file to generate a merged document. ---> <cfpdf action="processddx" ddxfile="Book.ddx" inputfiles="#inputStruct#" outputfiles="#outputStruct#" name="ddxVar"> <cfelse> <p>The DDX instructions are not valid.</p> </cfif> <!--- The following code displays a success or failure message. ---> <cfoutput>#ddxVar.Out1#</cfoutput>
The name attribute defines a variable that you use to determine the success or failure of the process. Use the cfoutput tag to display the success or failure message, as the previous example shows, or use the cfdump tag to display a structure:
<cfdump var="#ddxVar#">
This code returns the following information for each output file in the structure:
- "Successful", if the file is assembled successfully.
- "Reason for failure", if the file is not assembled successfully and the reason for failure is known.
- "Failure", if the file is not assembled successfully and the reason for failure is not known.
Use the IsDDX function to determine whether a DDX file or set of instructions is valid.
For detailed examples, see Assembling PDF Documents in the Developing ColdFusion Applications.
protect action Use the protect action to password-protect PDF output files, set permissions, and encrypt PDF output files. When you use the protect action, set a newUserPassword or a newOwnerPassword. (You can set both, as long as the passwords differ.) When you assign a user password to a document, all users must use this password to open the PDF document. The following code adds a user password to a PDF document:
<cfpdf action="protect" source="Finances.pdf" destination="myFinances.pdf" newUserPassword="keepOut">
To set the permissions on the output file, set the newOwnerPassword. A user who enters the owner password when accessing the PDF file is considered the owner of file. The following example shows how to set a new owner password:
<cfpdf action="protect" encrypt="AES_128"source="Book.pdf" destination="MysteryBook.pdf" overwrite="yes" newOwnerPassword="pssst" permissions="AllowDegradedPrinting">
Because the permissions are set to AllowDegradedPrinting in this example, ColdFusion lets users print the document at 150 DPI, but prohibits all other actions. If a user tries to delete the file, for example, ColdFusion generates an error message indicates that the password was entered incorrectly or the permissions do not allow the action to be performed.ColdFusion does not retain permissions: if you add a newUserPassword attribute, you also must set the permission explicitly.
To work with myVar, you specify newownerpw as the password.
PDF document passwords
A PDF document can have two kinds of passwords: a user password and an owner password. The following table describes the two types of ColdFusion passwords and their equivalents in Acrobat:
ColdFusion password |
Acrobat equivalent |
Description |
---|---|---|
User password |
Document Open password, user password |
Anyone who tries to open the PDF document must enter the password that you specify. A user password does not allow a user to change restricted features in the PDF document. |
Owner password |
Permissions password, master password |
Lets the person who enters the password restrict access to features in a PDF document. |
When you protect a PDF, your password changes to the one you provide. ColdFusion updates the variable's saved password to the one you provide. However, if you provide both passwords, ColdFusion uses the owner password. The following protects a PDF:
<cfpdf action="protect" source="myVar" password="oldpassword" permissions="none" newuserpassword="newuserpw" newownerpassword="newownerpw">
To get all the properties of the PDF, you do the following:
<cfpdf action="info" source="myVar" name="info">
To get only the properties allowed for the user, you do the following:
<cfpdf action="info" source="myVar" password=" newuserpw" name="info">
Permissions for PDF documents
The following table lists the permissions an owner can set for PDF documents:
Permissions |
Description |
---|---|
All |
There are no restrictions on the PDF document. |
AllowAssembly |
Users can add the PDF document to a merged document. |
AllowCopy |
Users can copy text, images, and other file content. This setting is required to generate thumbnail images with the thumbnail action. |
AllowDegradedPrinting |
Users can print the document at low-resolution (150 DPI). |
AllowFillIn |
Users can enter data into PDF form fields. Users can sign PDF forms electronically. |
AllowModifyAnnotations |
Users can add or change comments in the PDF document. |
AllowModifyContents |
Users can change the file content. Users can add the PDF document to a merged document. |
AllowPrinting |
Users can print the document at high-resolution (print-production quality). This setting is required for use with the cfprint tag. |
AllowScreenReaders |
Users can extract content from the PDF document. |
AllowSecure |
Users can sign the PDF document (with an electronic signature). |
None |
Users can view the document only. |
Encryption for PDF documents
The encrypt attribute sets the type of encryption used for opening a password-protected document. By default, ColdFusion uses the RC4 128-bit encryption algorithm to encrypt PDF files. To change the encryption algorithm, use the encrypt attribute with the protect action. The following code encrypts the PDF output file with the AES algorithm:
<cfpdf action="protect" encrypt="AES_128" source="Book.pdf" destination="MysteryBook.pdf" overwrite="yes" newOwnerPassword="pssst" permissions="AllowDegradedPrinting">
ColdFusion supports the following encryption algorithms:
Encryption algorithm |
Compatibility |
Description |
---|---|---|
AES_128 |
Adobe Acrobat 7.0 and later |
Advanced Encryption Standard (AES) specifies the Rijndael algorithm, a symmetric block cipher that can process data blocks of 128 bits. This is the highest encryption level.
|
RC4_128M |
Adobe Acrobat 6.0 and later |
RC4 specifies the RSA Security software stream cipher for algorithms such as Secure Sockets Layer (SSL), to protect Internet traffic, and WEP, to secure wireless networks.
|
RC4_128 |
Adobe Acrobat 5.0 and later |
RC4 128-bit encryption. This encryption algorithm lets users encrypt the document contents, but not the document metadata. |
RC4_40 |
Adobe Acrobat 3.0 and later |
RC4 40-bit encryption. This is the lowest encryption level. |
None |
- |
The document is not encrypted. |
Document metadata is used in Internet searches. If the metadata is encrypted, search engines cannot search the PDF document. Users running an earlier version of Acrobat cannot open a PDF document with a higher encryption setting. For example, if you specify AES 128 encryption, a user cannot open the document in Acrobat 6.0 or earlier.
- read action Use the read action to read the source PDF document into the namevariable, as the following code shows:
<cfif IsPDFFile("Book.pdf")> <cfpdf action="read" source="Book.pdf" name="myBook"> ... </cfif>
- removeWatermark action Use the removewatermarkaction to remove a watermark from a PDF document or specified pages in a document. The following example removes a watermark from the first page of a PDF document and writes the output to a new file:
<cfpdf action="removeWatermark" source="Book.pdf" pages="1" destination="newBook.pdf" overwrite="yes">
- removeheaderfooter action Use this action to remove the header and footer from a PDF document or from specified pages in a document. The following example removes the header and footer from the entire document:
<cfpdf action = "removeheaderfooter" source="..\mybook.pdf" destination = "new.pdf">
- setInfo action Use the setinfo action to specify information associated with a PDF document to be saved with it. Create a structure that contains the relevant information. Use the info attribute of the cfpdf tag to refer to the structure. The following code shows the elements that you can modify by using the setInfoaction:
<cfset PDFinfo=StructNew()> <cfset PDFinfo.Title="Make Way for Ducklings"> <cfset PDFinfo.Author="Donald Duck"> <cfset PDFinfo.Keywords="Huey,Dewy,Louie"> <cfset PDFinfo.Subject="Ducks"> <cfpdf action="setInfo" source="chap1.pdf" info="#PDFinfo#" destination="meta1.pdf" overwrite="yes">
- thumbnail action Use the thumbnail action to generate thumbnail images from the source PDF document.
If you do not specify a destination directory for the thumbnail files, ColdFusion creates a directory for the thumbnails in the directory where the CFM page is located. If you specify a filename as the source, the thumbnail directory name is a concatenation of the name of the source file and _thumbnails. For example, the following code generates a thumbnail image for each page in myBook.pdf and stores them in a directory called myBook_thumbnails:
<cfpdf action="thumbnail" source="myBook.pdf">
If the CFM page is located in the directory c:\myProject\genThumbnails.cfm, the pathname for the thumbnails directory is c:\myProject\myBook_thumbnails.By default, ColdFusion generates thumbnail files in JPEG format and the images are scaled to 25% of the original.
You can specify individual pages within the source document to generate thumbnails. Also, you can change the size of the thumbnail; the resolution, the output format (JPEG, PNG, or TIFF); and the prefix used for the thumbnail filenames. The following code generates a low-resolution thumbnail from the first page of the source document that is scaled at 50% of the original size:
<cfpdf action="thumbnail" source="myBook.pdf" pages="1" destination="c:\myBook\images" imagePrefix="Cover" format="png" scale="50" resolution="low">
The full output file pathname is as follows:
c:\myBook\images\Cover_page_1.png
To generate thumbnail images, the permissions of the source document must include AllowCopy. For more information, see Permissions for PDF documents in cfpdf.
With ColdFusion 9, the following new attributes were introduced for the thumbnail action:
hires: You can set this attribute to true to extract high-resolution images from the page. If a document contains high-resolution images and you want to retain the resolution of the images, then this attribute is useful.
For example:
<cfpdf action="thumbnail" source="./WORK/myBook.pdf" destination="./WORK/Testing_CFPDF" overwrite="true" hires="yes">
- overridepage: If you set this attribute to true, the thumbnail generated does not adhere to the PDF page size, but to the image size that is present in that page. If the image is not present, the size is set to the maximum size of the page.
compresstiffs: Use this attribute to compress the size of the thumbnail images. As the name of the attribute suggests, it is only valid for the TIFF format. Following is an example:
<cfpdf action="thumbnail" source="C:\WORK\myBook.pdf" destination="C:\WORK\Testing_CFPDF" overwrite="true" hires="yes" format="tiff" compresstiffs="yes">
- maxscale : Use this attribute to specify an integer value for the maximum scale of the thumbnail images.
- maxlength: Use this attribute to specify an integer value of the maximum length of the thumbnail images.
maxbreadth: Use this attribute to specify an integer value of the maximum width of the thumbnail.
The following example illustrates the use of maxscale, maxlength, and maxbreadth:
Note: Typically, the value of the scale attribute is set to 100 when using the maxscale attribute.
- write action Use the writeaction to write the source PDF document, or the PDF document stored in memory as a variable, to a file. The following code converts a PDF file stored in memory to a different PDF version and writes the output to a new file:
<cfpdf action="read" source="Book.pdf" name="myBook"> <cfpdf action="write" source="myBook" destination="myBook1.pdf" version="1.4">
You can now use either name or destination attributes with the write action. The name attribute takes the value as the PDF document variable. For example, you can write the preceding code snippet as:
<cfpdf action="read" source="Book.pdf" name="myBook"> <cfpdf action="write" source="myBook" name=#myBook# version="1.4">
The new encodeall attribute encodes all the unencoded streams in the source. However, it does not discriminate between dumb encodings like LZW and encodings like flate, so only unencoded streams get flateencoded.
You can now register thumbnail fonts using the font management screen.
PDF versions
Change the PDF version so that users running an older version of Acrobat or Adobe Reader can open the file. The following table shows the compatibility between the PDF version and the corresponding Acrobat and Adobe Reader versions:
PDF version |
Compatibility |
---|---|
1.1 |
Acrobat and Adobe Reader 2 |
1.2 |
Acrobat and Adobe Reader 3 |
1.3 |
Acrobat and Adobe Reader 4 |
1.4 |
Acrobat and Adobe Reader 5 |
1.5 |
Acrobat and Adobe Reader 6 |
1.6 |
Acrobat and Adobe Reader 7 |
To linearize PDF documents for faster web display, set the saveOption attribute to linear, as the following code shows:
<cfpdf action="write" source="myBook" destination="myBook1.pdf" saveOption="linear" overwrite="yes">
Do not use the linear save option if you have to maintain interactivity in PDF forms or if the PDF document is enabled for electronic signatures. To allow for electronic signatures, set the saveOption attribute to incremental, as the following code shows:
<cfpdf action="write" source="myDraft" destination="mySignedDoc.pdf" saveOption="incremental" overwrite="yes">
Use the flatten attribute to flatten forms created in Acrobat:
<cfpdf action="write" source="myAcrobatForm.pdf" destination="myFlatForm.pdf" flatten="yes" overwrite="yes">
ColdFusion does not support flattening forms created in Adobe LiveCycle. For more information about forms created in LiveCycle and Acrobat, see Manipulating PDF Forms in ColdFusion in the Developing ColdFusion Applications.
Example
The following example generates thumbnail images from pages in a PDF document and links the thumbnail images to the pages in the PDF document:
<h3>PDF Thumbnail Demo</h3> <!--- Create a variable for the name of the PDF document. ---> <cfset mypdf="myBook"> <cfset thisPath=ExpandPath(".")> <!--- Use the getInfo action to retrieve the total page count for the PDF document. ---> <cfpdf action="getInfo" source="#mypdf#.pdf" name="PDFInfo"> <cfset pageCount="#PDFInfo.TotalPages#"> <!--- Generate a thumbnail image for each page in the PDF source document, create a directory (if it doesn't already exist) in the web root that is a concatenation of the PDF source name and the word "thumbnails", and save the thumbnail images in that directory. ---> <cfpdf action="thumbnail" source="#mypdf#.pdf" overwrite="yes" destination="#mypdf#_thumbnails" scale=60> <!--- Loop through the images in the thumbnail directory and generate a link from each image to the corresponding page in the PDF document. ---> <cfloop index="LoopCount" from ="1" to="#pageCount#" step="1"> <cfoutput> <!--- Click the thumbnail image to navigate to the page in the PDF document. ---> <a href="#mypdf#.pdf##page=#LoopCount#" target="_blank"> <img src="#mypdf#_thumbnails/#mypdf#_page_#LoopCount#.jpg"></a> </cfoutput> </cfloop>
Archiving PDF documents
Introduced in ColdFusion 11: Use the action type=”archive” to archive the PDF files based on the ISO's PDF/A standards.PDF/A is one set of standards among a suite of PDF-based standards managed by the International Organization for Standardization (ISO). It was developed to enable the long-term preservation of electronic documents and provides specifications for the creation, viewing, and printing of PDF documents, with the intent of preserving final documents of record as self-contained documents. The standard does not define an archiving strategy or the goals of an archiving system. Rather, it identifies a "profile" for a PDF file that makes it possible to reproduce the visual appearance of the document the exact same way in the future. This profile specifies what must be included in the file, while prohibiting features that are not suitable for long-term archiving.
<!---- Create an archived pdf from source pdf ---à <cftry> <cfpdf action="archive" source="#sourcefilename#" destination="#destinationfilename#" overwrite="true" /> <cfcatch> <cfoutput>#cfcatch.detail#</cfoutput><br><br> </cfcatch> </cftry>
Digitally signing the documents
Introduced in ColdFusion 11: Use the action =”sign”,”unsign”,”validatesignature”,"readsignaturefields" for creating a digital signature, removing the digital signature, validating the signatures of a document, and for reading the signature fields respectively.
- For action =”sign”, the following attributes are available:
- keystore attribute(Required):The location of the keystore file. For example:C:\OpenSSL\bin\keystore.jks.
- keystorepassword attribute (Required): The password for the keystore.
- keyalias attribute (Optional):Alias of the key with which the certificate and private key are stored in the keystore. If it is not specified, the first entry in the keystore is chosen as the alias.
- keypassword attribute (Optional):Password for your private key. If not specified, the keystorepassword is used.
- author attribute (Optional): If true, generates an authored signature. If false, then generate an ordinary signature.
<!---- Sign a specific pdf by creating a signature field and signing it with authoured signature --> <cfpdf action="sign" source="#inputfilepath##inputfilename#" destination="#signedfilepath##signedfilename#" keystore="#certpath#cert.pfx" keystorepassword="certpass" overwrite="true" pages="1" height="100" width="100" position="100,100" author="false" />
- For action =”sign” and "unsign", the following attribute is available:
- signaturefieldname attribute(Optional):Fully qualified name of the existing field on which the user wants to sign (or) the signature field which has to be unsigned.
<!---- Sign a specific signature field in a input pdf ----> <cfpdf action="sign" source=”#inputfilepath##inputfilename#" destination="#signedfilepath##signedfilename#" keystore="#certpath#cert.jks" keystorepassword="password" overwrite="true" author="true" signaturefieldname="sign_me"/>
- For action =”unsign”, the following attribute is available:
- Unsignall attribute (Optional): If true, then will unsign all signature fields in the source document.
<cfpdf action="unsign" source="../cfpdf_normalPDFSign.pdf" destination="../results/cfpdf_normalPDFSign.pdf" unsignall="true" overwrite="true">
- For action =”validatesignature”, the following attribute is available:
- Name attribute which will store the resultant structure of this operation. It consists of two elements. One is the boolean field which indicates whether all signatures have been deemed valid or not. The second is an array list consisting of the names of all the signatures which were invalid.
<cfpdf action="validatesignature" source="../cfpdf_normalPDFSign.pdf" name="pdfInfo"> <cfoutput>#pdfInfo.SUCCESS#</cfoutput>
- For action =”readsignaturefields”:
- Reads all the signature fields and returns a query object in the variable indicated by attribute name. This query object will have five columns. The five columns are:
a) Signed - fully qualified name of the signature field.
b) Authored - indicates if this field can contain an author signature or not.
c) Can_Be_Signed - whether this field can be signed.
d) Can_Be_Authored - tells if this field is already signed or not
e) Visible - tells if the field is visible.
<!--- Read info about signature fields in a input pdf in a variable and dump it ---> <cfpdf action="readsignaturefields" source="#filepath##inputfilename#" name="signinfo" password="owner" /> <cfdump var=”#signinfo#”/>
Examples
addAttachments
<cfset sourcefile="#ExpandPath('file.pdf')#"> <cfset destinationfile="#ExpandPath('file_result.pdf')#"> <cftry> <cfpdf action="addAttachments" source="#sourcefile#" destination="#destinationfile#" overwrite="true"> <cfpdfparam source="#ExpandPath('file1.txt')#" filename="attachment1.txt" Encoding="ASCII" description="file attachment one"> <cfpdfparam source="#ExpandPath('file2.txt')#" filename="attachment2.txt" Encoding="UTF-16" description="file attachment one"></cfpdfparam> </cfpdf> <cfcatch type="any"> <cfdump var="#cfcatch#"> </cfcatch> </cftry>
Output
addFooter
<!--- image as footer ---> <cfset sourcefile="#ExpandPath('file.pdf')#"> <cfset destfile="#ExpandPath('file_footer.pdf')#"> <cfpdf action="addfooter" source="#sourcefile#" destination="#destfile#" image="adobe.png" overwrite="yes" > <!--- text as footer ---> <cfset sourcefile="#ExpandPath('file.pdf')#"> <cfset destfile="#ExpandPath('file_footer.pdf')#"> <cfpdf action="addfooter" source="#sourcefile#" destination="#destfile#" text="This is a sample footer" align="center" overwrite="yes" >
Output
addHeader
<!--- text as header ---> <cfset sourcefile="#ExpandPath('file.pdf')#"> <cfset destfile="#ExpandPath('file_header.pdf')#"> <cfpdf action="addheader" source="#sourcefile#" destination="#destfile#" text="This is a sample header" align="center" overwrite="yes" > <!--- image as header ---> <cfset sourcefile="#ExpandPath('file.pdf')#"> <cfset destfile="#ExpandPath('file_header.pdf')#"> <cfpdf action="addheader" source="#sourcefile#" destination="#destfile#" image="adobe.png" overwrite="yes" >
Output
addStamp
<cfset sourcefile=ExpandPath('addStamp.pdf')/> <cfset destinationfile=ExpandPath("addStamp_result.pdf")/> <cftry> <cfpdf action="addStamp" source="#sourcefile#" destination="#destinationfile#" overwrite="true"> <cfpdfparam pages="2" coordinates = "397,532,519,564" iconname="Approved" note="stamp1"> <cfpdfparam pages="3-4" coordinates = "397,532,519,564" iconname="Experimental" > <cfpdfparam pages="5" coordinates = "397,532,519,564" iconname="NotApproved" > <cfpdfparam pages="6" coordinates = "397,532,519,564" iconname="AsIs" note="stamp2"> <cfpdfparam pages="7-8" coordinates = "397,532,519,564" iconname="Expired" note="stamp3"> <cfpdfparam pages="9" coordinates = "397,532,519,564" iconname="NotForPublicRelease" > <cfpdfparam pages="10" coordinates = "397,532,519,564" iconname="Confidential" > <cfpdfparam pages="11" coordinates = "397,532,519,564" iconname="Final" note="stamp4"> <cfpdfparam pages="12" coordinates = "397,532,519,564" iconname="Sold"> <cfpdfparam pages="13" coordinates = "397,532,519,564" iconname="Departmental" note="stamp1"> <cfpdfparam pages="14" coordinates = "397,532,519,564" iconname="Draft"> <cfpdfparam pages="15" coordinates = "397,532,519,564" iconname="ForPublicRelease"> <cfpdfparam pages="16" coordinates = "397,532,519,564" iconname="TopSecret"> <cfpdfparam pages="17" coordinates = "397,532,519,564" iconname="ForComment"> </cfpdf> <cfcatch name="myvar"> <cfdump var="#myvar#"> </cfcatch> </cftry>
Output
addWatermark
<cfset sourcefile="#ExpandPath('file.pdf')#"> <cfset destfile="#ExpandPath('file_watermark.pdf')#"> <cfpdf action="addwatermark" source="#sourcefile#" destination="#destfile#" image="image.png" pages="1-2" overwrite="yes">
Output
archive
<!--- archive standard=2b ---> <cfset sourcefile="#ExpandPath('hello.pdf')#"/> <cfset archivedfile="#ExpandPath('Hello_archived.pdf')#"/> <cftry> <cfpdf action="archive" source="#sourcefile#" destination="#archivedfile#" standard="2b" overwrite="true"/> <cfcatch name="myvar"> <cfdump var="#myvar#"> </cfcatch> </cftry> <!--- archive standard=3b ---> <cfset sourcefile="#ExpandPath('hello.pdf')#"/> <cfset archivedfile="#ExpandPath('Hello_archived.pdf')#"/> <cftry> <cfpdf action="archive" source="#sourcefile#" destination="#archivedfile#" standard="3b" overwrite="true"/> <cfcatch name="myvar"> <cfdump var="#myvar#"> </cfcatch> </cftry>
Output
You can check the archiving of any file in Acrobat by going to:
Tools -> Print Production -> Pre Flight -> PDF/A Compliance -> [Verify compliance with
PDF/A-2b or Verify compliance with PDF/A-3b]. This will tell if PDF is compliant/ archived with the given standard or not.
deletePages
<cfset sourcefile="#ExpandPath('file.pdf')#"> <cfset destfile="#ExpandPath('file_pages_deleted.pdf')#"> <cfpdf action="deletepages" pages="5-10" source="#sourcefile#" destination="#destfile#" overwrite="yes" >
export comment
<cfset sourcefile=ExpandPath("comment.pdf")/> <cfset destinationfile=ExpandPath("comment_exported.fdf")/> <cfpdf action="export" type="comment" source="#sourcefile#" exportto="#destinationfile#" overwrite="true" >
Output
export metadata
<cfset sourcefile="#ExpandPath('metadata.pdf')#"/> <cfset destinationfile="#ExpandPath('metadata_exported.xmp')#"/> <cfpdf action="export" type="metadata" source="#sourcefile#" exportto="#destinationfile#" overwrite="true" >
Output
extractImage
<cfset sourcefile="#ExpandPath('coldfusion.pdf')#"> <cfpdf action = "extractimage" source = "#sourcefile#" pages = "1-20" destination = "images" imageprefix = "cf_" format="jpg" overwrite="yes" >
extractText
<cfset sourcefile="#ExpandPath('coldfusion.pdf')#"> <cfpdf action="extracttext" source="#sourcefile#" name="myXML" pages="1-10" overwrite="yes" > <cfcontent type="text/xml" /> <cfoutput>#myXML#</cfoutput>
getInfo
<cfset sourcefile=ExpandPath("coldfusion.pdf")/> <cfpdf action="getInfo" source="#sourcefile#" name="PDFInfo"> <cfdump var="#PDFInfo#" >
Output
import comments
<cfset sourcefile="#ExpandPath('noComment.pdf')#"/> <cfset destinationfile="#ExpandPath('withComment.pdf')#"/> <cfset importfromfilename = "#ExpandPath('comment_exported.xfdf')#"> <cfpdf action="import" type="comment" source="#sourcefile#" importfrom="#importfromfilename#" destination="#destinationfile#" overwrite="true" >
Output
import metadata
<cfset sourcefile="#ExpandPath('noMetadata.pdf')#"/> <cfset destinationfile="#ExpandPath('metadataImported.pdf')#"/> <cfset importfromfilename = "#ExpandPath('metadata_exported.xmp')#"> <cftry> <cfpdf action="import" type="metadata" source="#sourcefile#" importfrom="#importfromfilename#" destination="#destinationfile#" overwrite="true" > <cfcatch name="mycatch"> <cfdump var="#mycatch#" > </cfcatch> </cftry>
merge
Merge using a list of pdfs.
<cfset source1="#ExpandPath('coldfusion.pdf')#"/> <cfset source2="#ExpandPath('security.pdf')#"/> <cfset source3="#ExpandPath('sessionsecurity.pdf')#"/> <cfset desfile="#ExpandPath('merged.pdf')#"/> <cfpdf action="merge" source="#source1#,#source2#,#source3#" destination="#desfile#" overwrite="yes" >
Merge pdfs using cfpdfparam
<cfset source1="#ExpandPath('coldfusion.pdf')#"/> <cfset source2="#ExpandPath('security.pdf')#"/> <cfset source3="#ExpandPath('sessionsecurity.pdf')#"/> <cfset desfile="#ExpandPath('merged_new_PDF.pdf')#"/> <cfpdf action="merge" destination="#desfile#" overwrite="yes"> <cfpdfparam source="#source1#" pages="1-5"/> <cfpdfparam source="#source2#" pages=2 /> <cfpdfparam source="#source3#" pages="3-6" /> </cfpdf>
optimize
Using the Nearest Neighbor algorithm, which is the default.
<cfset sourcefile="#ExpandPath('coldfusion.pdf')#"/> <cfset desfile="#ExpandPath('optimized_nn.pdf')#"/> <cfpdf action="optimize" source="#sourcefile#" destination="#desfile#" algo="Nearest_Neighbour" overwrite="yes">
Using the bilinear algorithm.
<cfset sourcefile="#ExpandPath('coldfusion.pdf')#"/> <cfset desfile="#ExpandPath('optimized_biliear.pdf')#"/> <cfpdf action="optimize" source="#sourcefile#" destination="#desfile#" algo="bilinear" overwrite="yes">
Using the bicubic algorithm.
<cfset sourcefile="#ExpandPath('coldfusion.pdf')#"/> <cfset desfile="#ExpandPath('optimized_bicubic.pdf')#"/> <cfpdf action="optimize" source="#sourcefile#" destination="#desfile#" algo="bicubic" overwrite="yes">
processDDX
merge.ddx
<?xml version="1.0" encoding="UTF-8"?> <DDX xmlns="http://ns.adobe.com/DDX/1.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://ns.adobe.com/DDX/1.0/ coldfusion_ddx.xsd"> <PDF result="Out1"> <PDF source="Doc1"/> <PDF source="Doc2"/> </PDF> </DDX>
processDDX .cfm
<cfset source1="#ExpandPath('security.pdf')#"/> <cfset source2="#ExpandPath('sessionsecurity.pdf')#"/> <cfset outfile="#ExpandPath('book.pdf')#"/> <cfset ddxloc="#ExpandPath('merge.ddx')#"/> <!--- This code creates a structure for the input files. ---> <cfset inputStruct=StructNew()> <cfset inputStruct.Doc1="#source1#"> <cfset inputStruct.Doc2="#source2#"> <!--- This code creates a structure for the output file. ---> <cfset outputStruct=StructNew()> <cfset outputStruct.Out1="#outfile#"> <!--- This code processes the DDX instructions and generates the book. ---> <cfpdf action="processddx" ddxfile="#ddxloc#" inputfiles="#inputStruct#" outputfiles="#outputStruct#" name="myBook"> <cfdump var="#myBook#">
protect
<cfset sourcefile="#ExpandPath('coldfusion.pdf')#"/> <cfset desfile="#ExpandPath('coldfusion_protected.pdf')#"/> <cfpdf action="protect" source="#sourceFile#" destination="#desfile#" newUserPassword="password" >
Output
read
<cfset sourcefile="#ExpandPath('coldfusion.pdf')#"/> <cfpdf action="read" name="myBook" source="#sourcefile#" > <cfdump var="#myBook#" >
Output
redact
<cfset sourcefile=ExpandPath('redact.pdf')/> <cfset destinationfile=ExpandPath("redact_result.pdf")/> <cfpdf action="redact" source="#sourcefile#" destination="#destinationfile#" overwrite="true"> <cfpdfparam pages="1,2" coordinates="306,426,366,496" > <cfpdfparam pages="3" coordinates="100,100,400,400"> <cfpdfparam pages="*" coordinates="0,0,100,100"> </cfpdf>
Output
removeHeaderFooter
<cfset sourcefile=ExpandPath('coldfusion_header_footer.pdf')/> <cfset desfile=ExpandPath('coldfusion_no_header_footer.pdf')/> <cfpdf action = "removeheaderfooter" source="#sourcefile#" destination = "#desfile#" pages="1-5" overwrite="yes" >
removeWatermark
<cfset sourcefile=ExpandPath('coldfusion_watermark.pdf')/> <cfset desfile=ExpandPath('coldfusion_no_watermark.pdf')/> <cfpdf action = "removewatermark" source="#sourcefile#" destination = "#desfile#" pages="3-5" overwrite="yes" >
sanitize
<cfset sourcefile="#ExpandPath('CF_Hotfix.pdf')#"/> <cfset destinationfile="#ExpandPath('CF_Hotfix_Sanitized.pdf')#"/> <cfpdf action="sanitize" source="#sourcefile#" destination="#destinationfile#" overwrite="true" >
Output - before sanitization
Output - after sanitization
setInfo
<cfset PDFinfo=StructNew()> <cfset PDFinfo.Title="Apply Hotfixes to ColdFusion"> <cfset PDFinfo.Author="ColdFusion Developer"> <cfset PDFinfo.Keywords="ColdFusion,Update, Hotfix, Security Update"> <cfset PDFinfo.Subject="ColdFusion Hotfixes"> <cfset sourcefile="file.pdf"/> <cfset desfile="file_info.pdf"/> <cfpdf action="setInfo" source="#sourcefile#" info="#PDFinfo#" destination="#desfile#" overwrite="yes" >
Output
sign
Create a Keystore and generate a key pair. Answer each question when prompted.
keytool - genkey -alias pdfdomain - keyalg RSA - keystore KeyStore.jks - keysize 2048
Generate a CSR based on the new keystore .
keytool - certreq -alias pdfdomain - keystore KeyStore.jks -file pdfdomain . csr
<!---- Sign a specific pdf by creating a signature field and signing it with authoured signature ---> <cfset sourcefile=ExpandPath('coldfusion.pdf')/> <cfset destinationfile=ExpandPath("cf_signed.pdf")/> <cfset pathtokeystore=ExpandPath("KeyStore.jks")/> <cfpdf action="sign" source="#sourcefile#" destination="#destinationfile#" keystore="#pathtokeystore#" keystorepassword="password" overwrite="true" pages="1" height="100" width="100" position="100,100" author="true" >
Output
thumbnail
<cfset sourcefile="#ExpandPath('coldfusion.pdf')#"> <cfpdf action="read" name="myDoc" source="#sourcefile#" /> <cfpdf action="thumbnail" source="myDoc" destination="C:\cfpdf\" overwrite="yes" /> <cfimage action="read" name="img" source="C:\cfpdf\thumbnail_page_1.jpg" format="jpg" />
Output
transform
<cfset sourcefile="#ExpandPath('coldfusion.pdf')#"> <cfset desfile="#ExpandPath('coldfusion_transformed.pdf')#"> <cfpdf action = "transform" source = "#sourcefile#" destination = "#desfile#" hscale = ".5" vscale = ".8" position = "8, 10" rotation = "180" overwrite="yes" >
Output
unsign
<cfset sourcefile=ExpandPath('cf_signed.pdf')/> <cfset destinationfile=ExpandPath("cf_unsigned.pdf")/> <cfpdf action="unsign" source="#sourcefile#" destination="#destinationfile#" unsignall="true" overwrite="true" >
Output
validatesSignature
<cfset sourcefile="#ExpandPath('cf_signed.pdf')#"> <cfpdf action="validatesignature" source="#sourceFile#" name="pdfInfo"> <cfoutput>#pdfInfo.SUCCESS#</cfoutput> <!--- returns YES --->
write
<!--- write the properties of the PDF ---> <cfset sourcefile="#ExpandPath('coldfusion.pdf')#"> <cfpdf action="write" source="#sourcefile#" name="PDFout" overwrite="yes"> <cfdump var="#PDFout#" >
<!--- Write the PDF document to another PDF ---> <cfset sourcefile="#ExpandPath('coldfusion.pdf')#"> <cfset desfile="#ExpandPath('coldfusion_write.pdf')#"> <cfpdf action="write" source="#sourcefile#" destination="#desfile#" overwrite="yes" >