User Guide Cancel

cfpdfparam

Last updated on May 30, 2024 | Also applies to ColdFusion

CFML Reference User Guide
ColdFusion functions
ColdFusion Tags
1. ColdFusion tag summary
2. ColdFusion tags by category
  1. Application framework tags
    1. cfapplication
    2. cfassociate
    3. cferror
    4. cfimport
    5. cfinterface
    6. cflock
    7. cfscript
    8. cfthread
  2. Communications tags
  3. Database manipulation tags
  4. Data output tags
    1. cfchart
    2. cfchartdata
    3. cfchartseries
    4. cfcol
    5. cfcontent
    6. cfdocument
    7. cfdocumentitem
    8. cfdocumentsection
    9. cfflush
    10. cfheader
    11. cflog
    12. cfoutput
    13. cfpresentation
    14. cfpresentationslide
    15. cfpresenter
    16. cfprocessingdirective
    17. cfprint
    18. cfreport
    19. cfreportparam
    20. cfsilent
    21. cftable
  5. Debugging tags
    1. cfdump
    2. cftimer
    3. cftrace
  6. Exception handling tags
    1. cfcatch
    2. cferror
    3. cffinally
    4. cfrethrow
    5. cfthrow
    6. cftry
  7. Extensibility tags
    1. cfchart
    2. cfchartdata
    3. cfchartseries
    4. cfcollection
    5. cfcomponent
    6. cfexecute
    7. cfftp
    8. function
    9. cfindex
    10. cfinterface
    11. cfinvoke
    12. cfinvokeargument
    13. cfobject
    14. cfproperty
    15. cfreport
    16. cfreportparam
    17. cfreturn
    18. cfsearch
    19. cfsharepoint
    20. cfspreadsheet
    21. cfwddx
    22. cfxml
  8. File management tags
    1. cfdirectory
    2. cffile
    3. cffileupload
    4. cfftp
    5. cfzip
    6. cfzipparam
  9. Flow-control tags
    1. cfabort
    2. cfbreak
    3. cfcase
    4. cfcontinue
    5. cfdefaultcase
    6. cfelse
    7. cfelseif
    8. cfexecute
    9. cfexit
    10. cfif
    11. cfinclude
    12. cflocation
    13. cfloop
    14. cfrethrow
    15. cfswitch
    16. cfthrow
    17. cftry
  10. Forms tags
    1. cfapplet
    2. cfcalendar
    3. cffileupload
    4. cfform
    5. cfformgroup
    6. cfformitem
    7. cfgrid
    8. cfgridcolumn
    9. cfgridrow
    10. cfgridupdate
    11. cfinput
    12. cfpdf
    13. cfpdfform
    14. cfpdfformparam
    15. cfpdfparam
    16. cfpdfsubform
    17. cfselect
    18. cfslider
    19. cftextarea
    20. cftree
    21. cftreeitem
  11. Internet Protocol tags
    1. cfajaximport
    2. cfajaxproxy
    3. cfftp
    4. cffeed
    5. cfimap
    6. cfhttp
    7. cfhttpparam
    8. cfldap
    9. cfmail
    10. cfmailparam
    11. cfmailpart
    12. cfpop
    13. cfsprydataset
  12. Page processing tags
    1. cfcache
    2. cfcontent
    3. cfflush
    4. cfheader
    5. cfhtmlhead
    6. cfinclude
    7. cfprocessingdirective
    8. cfsetting
    9. cfsilent
  13. Security tags
  14. Variable manipulation tags
    1. cfcookie
    2. cfdump
    3. cfparam
    4. cfregistry
    5. cfsavecontent
    6. cfschedule
    7. cfset
    8. cfsetting
  15. Other tags
    1. cfimage
    2. cflog
    3. cfregistry
3. Tags a-b
4. Tags c
  1. cfcache
  2. cfcalendar
  3. cfcase
  4. cfcatch
  5. cfchart
  6. cfchartdata
  7. cfchartseries
  8. cfclient
  9. cfclientsettings
  10. cfcol
  11. cfcollection
  12. cfcomponent
  13. cfcontent
  14. cfcontinue
  15. cfcookie
  16. Tags d-e
5. Tags f
6. Tags g-h
  1. cfgraph
  2. cfgraphdata
  3. cfgrid
  4. cfgridcolumn
  5. cfgridrow
  6. cfgridupdate
  7. cfheader
  8. cfhtmlhead
  9. cfhtmltopdf
  10. cfhtmltopdfitem
  11. cfhttp
  12. cfhttpparam
7. Tags i
  1. cfif
  2. cfimage
  3. cfimap
  4. cfimapfilter
  5. cfimpersonate
  6. cfimport
  7. cfinclude
  8. cfindex
  9. cfinput
  10. cfinsert
  11. cfinterface
  12. cfinvoke
  13. cfinvokeargument
8. Tags j-l
9. Tags m-o
10. Tags p-q
  1. cfparam
  2. cfpdf
  3. cfpdfform
  4. cfpdfformparam
  5. cfpdfparam
  6. cfpdfsubform
  7. cfpod
  8. cfpop
  9. cfpresentation
  10. cfpresentationslide
  11. cfpresenter
  12. cfprint
  13. cfprocessingdirective
  14. cfprocparam
  15. cfprocresult
  16. cfprogressbar
  17. cfproperty
  18. cfquery
  19. cfqueryparam
11. Tags r-s
  1. cfregistry
  2. cfreport
  3. cfreportparam
  4. cfrethrow
  5. cfreturn
  6. cfsavecontent
  7. cfschedule
  8. cfscript
  9. cfsearch
  10. cfselect
  11. cfservlet
  12. cfservletparam
  13. cfset
  14. cfsetting
  15. cfsharepoint
  16. cfsilent
  17. cfslider
  18. cfspreadsheet
  19. cfsprydataset
  20. cfstoredproc
  21. cfswitch
12. Tags t
  1. cftable
  2. cftextarea
  3. cftextinput
  4. cfthread
  5. cfthrow
  6. cftimer
  7. cftooltip
  8. cftrace
  9. cftransaction
  10. cftree
  11. cftreeitem
  12. cftry
13. Tags u-z
  1. cfupdate
  2. cfwddx
  3. cfwebsocket
  4. cfwindow
  5. cfxml
  6. cfzip
  7. cfzipparam
CFML Reference
1. Reserved words and variables
2. Ajax JavaScript functions
3. ColdFusion ActionScript functions
4. ColdFusion mobile functions
5. Application.cfc reference
6. Script functions implemented as CFCs
7. ColdFusion Flash Form style reference
8. ColdFusion event gateway reference
9. ColdFusion C++ CFX Reference
10. ColdFusion Java CFX reference
11. WDDX JavaScript Objects
Cloud services

Description

Provides additional information for the cfpdf tag. The cfpdfparam tag applies only to the merge action of the cfpdf tag and is always a child tag of the cfpdf tag.

History

ColdFusion 8: Added this tag.

Syntax

<cfpdf action = "merge" ..> 
<cfpdfparam 
pages = "page number|page range|comma-separated page numbers" 
password = "user or owner password" 
source = "absolute or relative pathname to a PDF file|PDF document variable| 
cfdocument variable"> 
</cfpdf>

You can attach PDFs and other types of files to a PDF. If you move the PDF to a new location, the attachments move with it. By using cfpdfparam, you can specify the location of the attachment, the filename for the attachment, description of the attachment, encoding, and mimetype for attaching file. Files can be attached at document level.

<cfpdfparam
   // required
   source= "path of attachment"
   filename = "filename for the attachment"
   encoding = "encoding for filename" >
   // optional  
   description = "descriptive text"
   mimetype = "application/pdf, text/html">
/>

Attribute name	Req/optional	Description
action	Req	Action to take: addAttachments
source	Req	absolute or relative pathname to a PDF file\| PDF document variable or cfdocument variable
filename	Req	filename for the attachment
mimetype	Optional	Some of the sample mimetype attribute values are: text/html, application/pdf.
encoding	Req	Type of encoding for filename. UTF-8 is the default.
description	Optional	Description for the attachment
destination/name	Req	destination = "PDF output file pathname". name = “PDF document variable name”. If the destination file exists, set the overwrite attribute to yes . If the destination file does not exist, ColdFusion creates the file, if the parent directory exists.

Note:

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.

Attributes

Attribute	Req/Opt	Description
pages	Optional	Page or pages of the PDF source file to merge. You can specify a range of pages, for example, "1-5 ", or a comma-separated list of pages, for example, "1-5,9-10,18".
password	Optional	User or owner password, if the source PDF file is password-protected.
source	Required	Source PDF file to merge. You can specify a PDF variable, a cfdocument variable, or the pathname to a file.

Usage

Use the cfpdfparam tag to merge several PDF documents into one file. The cfpdfparam tag lets you specify the order of source files explicitly. You can use this tag to merge pages from multiple PDF document source files in different locations.
The following code creates a single PDF document called combined.pdf that contains pages 1-3 and page 5 of the file abc.pdf, followed by all of the pages in xyz.pdf, a file in memory with the variable name myPDFvariable, and lastly pages 10-90 from the file abc.pdf. The password attribute applies only if the source file is password-protected:

<cfpdf action="merge" destination="combined.pdf" overwrite="yes"> 
<cfpdfparam source="c:\abc.pdf" pages="1-3,5" password="adobe"> 
\\x 
<cfpdfparam source="myPDFvariable"> 
<cfpdfparam source="abc.pdf" pages="10-90" password="adobe"> 
</cfpdf>

Note:

When you use the cfpdfparam tag with the cfpdf merge action, you must specify either the destination attribute or the name attribute for the cfpdf tag.

Example

The following ColdFusion page creates a form for downloading tax forms and tax information booklets:

<h3>Downloading Federal Tax Documents</h3> 
<p>Please choose the your type of business.</p> 
<!--- Create the ColdFusion form to determine which PDF documents to merge. ---> 
<table> 
<cfform action="cfpdfMergeAction.cfm" method="post"> 
<tr><td><cfinput type="radio" name="businessType" Value="SoleP"> 
Sole Proprieter</td></tr> 
<tr><td><cfinput type="radio" name="businessType" 
Value="Partner">Partnership</td></tr> 
<tr><td><cfinput type="radio" name="businessType" Value="SCorp">S Corporation</td></tr> 
<cfinput type = "hidden" name = "selection required" value = "must make a selection"> 
<tr><td><cfinput type="Submit" name="OK" label="OK"></td></tr> 
</tr> 
</cfform> 
</table>

The ColdFusion action page merges PDF files in different locations based on the selection in the form:

<!--- Create a merged PDF document based on the selection in the form. ---> 
<cfpdf action="merge" name="taxDoc"> 
<cfif #form.businessType# is "SoleP"> 
<cfpdfparam source="taxForms\f2106ez.pdf"> 
<cfpdfparam source="taxForms\f1040.pdf"> 
<cfpdfparam source="taxForms\f1040sc.pdf"> 
<cfpdfparam source="taxInfo\i1040sc.pdf"> 
<cfpdfparam source="taxInfo\i2106.pdf"> 
<cfpdfparam source="taxInfo\i1040sc.pdf"> 
<cfpdfparam source="taxInfo\p535.pdf"> 
<cfpdfparam source="taxInfo\p560.pdf"> 
<cfpdfparam source="taxInfo\p334.pdf"> 
<cfelseif #form.businessType# is "Partner"> 
<cfpdfparam source="taxForms\f1065.pdf"> 
<cfpdfparam source="taxForms\f1065b.pdf"> 
<cfpdfparam source="taxForms\f1065bsk.pdf"> 
<cfpdfparam source="taxForms\f8804.pdf"> 
<cfpdfparam source="taxForms\f8825.pdf"> 
<cfpdfparam source="taxInfo\p535.pdf"> 
<cfpdfparam source="taxInfo\p560.pdf"> 
<cfpdfparam source="taxInfo\i1065bsk.pdf"> 
<cfelseif #form.businessType# is "SCorp"> 
<cfpdfparam source="taxForms\f1120s.pdf"> 
<cfpdfparam source="taxForms\f2553.pdf"> 
<cfpdfparam source="taxForms\f8453s.pdf"> 
<cfpdfparam source="taxForms\f8825.pdf"> 
<cfpdfparam source="taxInfo\i1120s.pdf"> 
<cfpdfparam source="taxInfo\p542.pdf"> 
<cfpdfparam source="taxInfo\p535.pdf"> 
<cfpdfparam source="taxInfo\p560.pdf"> 
</cfif> 
</cfpdf> 

<cfpdf action="write" source="taxDoc" destination="c:\taxDoc.PDF" 
overwrite="yes"/>

Note:

ColdFusion automatically flattens form fields when you use the merge action of the cfpdf tag.

Get help faster and easier

New user?

cfpdfparam

Description

History

Category

Syntax

See also

Attributes

Usage

Example

Get help faster and easier

Ask the Community

Contact Us