Including pages with the cfinclude tag
165
The model of an included page is that it is part of your page; it just resides in a separate file. The
cfinclude
tag cannot pass parameters to the included page, but the included page has access to
all the variables on the page that includes it. The following figure shows this model:
Using the cfinclude tag
When you use the
cfinclude
tag to include one ColdFusion page in another ColdFusion page,
the page that includes another page is referred to as the
calling
page. When ColdFusion
encounters a
cfinclude
tag it replaces the tag on the calling page with the output from
processing the included page. The included page can also set variables in the calling page.
The following line shows a sample
cfinclude
tag:
<cfinclude template = "header.cfm">
Note:
You cannot break CFML code blocks across pages. For example, if you open a
cfoutput
block in a ColdFusion page, you must close the block on the same page; you cannot include the
closing portion of the block in an included page.
ColdFusion searches for included files as follows:
•
The
template
attribute specifies a path relative to the directory of the calling page.
•
If the template value is prefixed with a forward slash (/), ColdFusion MX searches for the
included file in directories that you specify on the Mappings page of the ColdFusion MX
Administrator.
Caution:
A page must not include itself. Doing so causes an infinite processing loop, and you must
stop the ColdFusion server to resolve the problem.
To include code in a calling page:
1
Create a ColdFusion page named header.cfm that displays your company’s logo. Your page can
consist of just the following lines, or it can include many lines to define an entire header:
<img src="mylogo.gif">
<br>
(For this code to work, you must also put your company’s logo as a GIF file in the same
directory as the header.cfm file.)
2
Create a ColdFusion page with the following content:
<html>
<head>
Summary of Contents for COLDFUSION MX 61-DEVELOPING COLDFUSION MX
Page 1: ...Developing ColdFusion MX Applications...
Page 22: ...22 Contents...
Page 38: ......
Page 52: ...52 Chapter 2 Elements of CFML...
Page 162: ......
Page 218: ...218 Chapter 10 Writing and Calling User Defined Functions...
Page 250: ...250 Chapter 11 Building and Using ColdFusion Components...
Page 264: ...264 Chapter 12 Building Custom CFXAPI Tags...
Page 266: ......
Page 314: ...314 Chapter 14 Handling Errors...
Page 344: ...344 Chapter 15 Using Persistent Data and Locking...
Page 349: ...About user security 349...
Page 357: ...Security scenarios 357...
Page 370: ...370 Chapter 16 Securing Applications...
Page 388: ...388 Chapter 17 Developing Globalized Applications...
Page 408: ...408 Chapter 18 Debugging and Troubleshooting Applications...
Page 410: ......
Page 426: ...426 Chapter 19 Introduction to Databases and SQL...
Page 476: ...476 Chapter 22 Using Query of Queries...
Page 534: ...534 Chapter 24 Building a Search Interface...
Page 556: ...556 Chapter 25 Using Verity Search Expressions...
Page 558: ......
Page 582: ...582 Chapter 26 Retrieving and Formatting Data...
Page 668: ......
Page 734: ...734 Chapter 32 Using Web Services...
Page 760: ...760 Chapter 33 Integrating J2EE and Java Elements in CFML Applications...
Page 786: ...786 Chapter 34 Integrating COM and CORBA Objects in CFML Applications...
Page 788: ......