User Guide Cancel

cfdocumentitem

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

Specifies action items for a PDF or FlashPaper document created by the cfdocument tag. Action items include the following:

header
footer
pagebreak

Syntax

<cfdocument ...> 
<cfdocumentitem 
type = "pagebreak|header|footer" 
evalAtPrint = "true" 
header/footer text </cfdocumentitem> 
</cfdocument>

History

ColdFusion 9: Added the evalAtPrint attribute.

ColdFusion 8: Added support for cfdocument.currentpagenumber, cfdocument.totalpagecount cfdocument.totalsectionpagecount, and cfdocument.currentsectionpagenumber scopevariables.

ColdFusion MX 7.01: Added the src, srcfile, and mimetype attributes.ColdFusion MX 7: Added this tag.

Attributes

Attribute	Req/Opt	Default	Description
type	Required		Specifies the action: pagebreak: starts a new page at the location of the tag. header: uses the text between the <cfdocumentitem> and </cfdocumentitem> tags as the running header. footer: uses the text between the <cfdocumentitem> and </cfdocumentitem> tags as the running footer.
evalAtPrint	Optional	false	A Boolean value that determines if the contents of the cfdocumentitem tag body has to be evaluated at the time of printing the document. true: evaluates the contents of the cfdocumentitem tag body only at the time of printing the document. false: evaluates the contents of the cfdocumentitem tag body immediately.

Attribute

Req/Opt

Default

Description

type

Required

Specifies the action:

pagebreak: starts a new page at the location of the tag.
header: uses the text between the <cfdocumentitem> and </cfdocumentitem> tags as the running header.
footer: uses the text between the <cfdocumentitem> and </cfdocumentitem> tags as the running footer.

evalAtPrint

Optional

false

A Boolean value that determines if the contents of the cfdocumentitem tag body has to be evaluated at the time of printing the document.

true: evaluates the contents of the cfdocumentitem tag body only at the time of printing the document.
false: evaluates the contents of the cfdocumentitem tag body immediately.

Usage

Use the evalAtPrint tag to evaluate the contents of the document before printing and to also accept additional attributes. Use the cfdocumentitem tag to control the formatting of a PDF or FlashPaper report. This tag must be wrapped inside a <cfdocument> </cfdocument> pair.
Write code for one cfdocumentitem tag for each page break, running header, or running footer. ColdFusion has added support for cfdocument scope variables within the cfdocumentitem tag. You can use the cfdocument scope variable, cfdocument.currentpagenumber, to display the current page number in a header or footer. You can also use {{cfdocument.totalpagecoun}}t to display the total number of pages, for example:

...
<cfdocumentitem type= "footer>
#cfdocument.currentpagenumber# of #cfdocument.totalpagecount#
</cfdocumentitem>

For an example that uses the cfdocument.totalsectionpagecount and cfdocument.currentsectionpagenumber scope variables, see cfdocument.
You can use cfdocumentitem tags with or without the cfdocumentsection tag, as follows:

Without cfdocumentsection The cfdocumentitemattribute applies to the entire document, as follows:
- If the tag is at the top of the document, it applies to the entire document.
- If the tag is in the middle of the document, it applies to the rest of the document.
- If the tag is at the end of the document, it has no affect.

With cfdocumentsection tags The cfdocumentitem attribute applies only to the section and overrides previously specified header and footer specifications.

Example

<cfquery datasource="cfdocexamples" name="parksQuery"> 
SELECT parkname, suptmgr from parks 
</cfquery> 

<cfdocument format="PDF"> 
<cfdocumentitem type="header">National Parks Report</cfdocumentitem> 
<!--- Use a footer with current page of totalpages format. ---> 
<cfdocumentitem type="footer"> 
<cfoutput>Page #cfdocument.currentpagenumber# of #cfdocument.totalpagecount#</cfoutput> 
</cfdocumentitem> 

<h1>Park list</h1> 
<table width="95%" border="2" cellspacing="2" cellpadding="2" > 
<tr> 
<th>Park</th> 
<th>Manager</th> 
</tr> 
<cfoutput query="parksQuery"> 
<tr> 
<td><font size="-1">#parkname#</font></td> 
<td><font size="-1">#suptmgr#</font></td> 
</tr> 
</cfoutput> 
</table> 
</cfdocument>

Adobe

Get help faster and easier

New user?

cfdocumentitem

Description

Category

Syntax

See also

History

Attributes

Usage

Example

Get help faster and easier

Ask the Community

Contact Us