<cfdocumentitem>

edit

Specifies action items for a PDF document created by the cfdocument tag.

This tag may have a body.

This tag is also supported within <cfscript>

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

<cfdocumentitem type=string name=string evalAtPrint=boolean ><!--- body --->[</cfdocumentitem>]
Attribute Description
type
string, required 		edit

Specifies the action:

  • pagebreak (starts a new page at the location of the tag)
  • header (uses the text between in the body of the tag as the running header)
  • footer (uses the text between the body of the tag as the running footer)
  • bookmark (set a bookmark, use the attribute name to define the name of the bookmark)
name
string, optional 		edit

used only for type bookmark, name of the bookmark to define.

Unimplemented Attribute(s)

Attribute Description
evalAtPrint
boolean, optional 		edit

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 (default): evaluates the contents of the cfdocumentitem tag body immediately.
* unimplemented *

Examples

edit

Simple example for cfdocumentitem

<cfdocument format="pdf">
	<h1>Welcome to Lucee</h1>
	<h5>Example Page</h5>
	<p>Example for <b>CfdocumentItem</b></p>
	<cfdocumentitem type="header">
		<h2><i>Example Header</i></h2>
	</cfdocumentitem>
	<cfdocumentitem type="footer">
		<h2><i>Example footer</i></h2>
	</cfdocumentitem>
</cfdocument>

See also