Reusing Code

Often times, you'll use some of the same elements in multiple pages; for example, navigation, headers, and footer code.

Instead of copying and maintaining it from page to page, ColdFusion allows you to reference the code stored in one file in many pages. This way you can modify one file and recognize the changes throughout an entire application.

Use the CFINCLUDE tag to automatically include an existing file in the current page.

CFINCLUDE Syntax

<CFINCLUDE Template="File.cfm">

• The page that calls the template is also known as the calling page.
• The TEMPLATE attribute describes the file or template to include in the calling page.
• The TEMPLATE attribute describes the template - including where it resides or its path.
• Each time the calling page is requested, the template's file contents are included in that page for processing.

Note:

Refer to the CFML Language Reference for ColdFusion Express for CFINCLUDE syntax.

Usage example

In this example, the navigation toolbar is included (not copied) at the top of the calling page, EmpList.cfm:

<CFINCLUDE TEMPLATE="Toolbar.cfm">

• Each and every time the template page is requested, the contents of Toolbar.cfm is included for processing.
• Toolbar.cfm resides in the same directory as Emplist.cfm.
• If Toolbar.cfm resided in the Templates directory underneath the calling page's directory, the syntax would be:

    <CFINCLUDE TEMPLATE="Templates/toolbar.cfm">

During the next procedure, use CFINCLUDE on your EmpList.cfm and FormAction.cfm pages to reuse the application's navigation code.

To reference code in a calling page:

1. Open EmpList.cfm in HomeSite.
2. Delete the existing toolbar code that begins with this:

<!--- begin application toolbar imported from toolbar.cfm--->

And ends with this:

<!--- end application toolbar --->
3. Include Toolbar.cfm file in this page:

<CFINCLUDE TEMPLATE="ToolBar.cfm">

4. Save the page.
5. View EmpList.cfm in a browser.
6. The toolbar should still appear at the top of the page.
7. Return to HomeSite.
8. Open FormPage.cfm.
9. Save it as SearchForm.cfm.

You will modify this form during the next chapter's procedures to create a search form.

10. Add the CFINCLUDE tag directly below the opening BODY tag.
11. Save the page.
12. View EmpList.cfm in a browser and navigate to SearchForm.cfm by clicking SEARCH.

The toolbar should now be included.

13. Click LIST to return to EmpList.cfm.

Click here to see what the Emplist.cfm looks like.

Click here to see what SearchForm.cfm looks like.

Click here to see the search form's code.

In the next chapter, you will code the form so that it really does search the database.

Move on in this chapter to review development considerations.

Copyright © 1999, Allaire Corporation. All rights reserved.