cfinclude

Description

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.)

Category

Flow-control tags, Page processing tags

Syntax

<cfinclude 
  template = "template_name"> 

See also

cfcache, cfflush, cfheader, cfhtmlhead, cfsetting, cfsilent

History

New in ColdFusion MX: If you use this tag to include a CFML page whose length is zero bytes, an empty page displays. (In earlier releases, an error message displays.)

Attributes

Attribute Req/Opt Default Description
template
Required
 
A logical path to a ColdFusion page.

Usage

ColdFusion searches for included files in the following sequence:

  1. In the directory of the current page
  2. In directories mapped in the ColdFusion Administrator for the included file

Example

<!--- 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">

Comments