Embeds references to ColdFusion pages in CFML. You can embed cfinclude
tags recursively. For another way to encapsulate CFML, see cfmodule. (A ColdFusion page was formerly sometimes called a ColdFusion template or a template.)
Flow-control tags, Page processing tags
<cfinclude
template = "template_name">
cfcache
,
cfflush
,
cfheader
,
cfhtmlhead
,
cfsetting
,
cfsilent
ColdFusion MX: Changed error behavior: if you use this tag to include a CFML page whose length is zero bytes, you do not get an error.
Attribute | Req/Opt | Default | Description |
---|---|---|---|
template |
Required |
|
A logical path to a ColdFusion page. |
ColdFusion searches for included files in the following sequence:
The included file must be a syntactically correct and complete CFML page. For example, to output data from within the included page, you must have a cfoutput
tag, including the end tag, on the included page, not the referring page. Similarly, you cannot span a cfif
tag across the referring page and the included page; it must be complete within the included page.
<!--- This example shows the use of cfinclude to paste CFML
or HTML code into another page dynamically ---> <h4>This example includes the main.htm page from the CFDOCS directory.
The images do not display, because they are located in
a separate directory. However, the page appears fully rendered
within the contents of this page.</h4> <cfinclude template = "/cfdocs/main.htm">