User Guide

250 Chapter 2: ColdFusion Tags
cfmodule
Description
Invokes a custom tag for use in ColdFusion application pages. This tag processes custom tag
name conflicts.
For more information, see Chapter 9, “Creating and Using Custom CFML Tags,” in Developing
ColdFusion MX Applications.
Category
Application framework tags
Syntax
<cfmodule
template = "path"
name = "tag_name"
attributeCollection = "collection_structure"
attribute_name1 = "valuea"
attribute_name2 = "valueb"
...>
See also
cfapplication, cfassociate, cflock,
Chapter 9, “Creating and Using Custom CFML
Tags,” in Developing ColdFusion MX Applications
History
ColdFusion MX: Changed behavior when using this tag within a custom tag: if the
attribute_name parameter is the same as a key element within the attributeCollection
parameter, ColdFusion now uses the name value that is within the
attributeCollection
parameter. (Earlier releases did not process this consistently.)
Attributes
Attribute Req/Opt Default Description
template Required
unless
name
attribute is used
Mutually exclusive with the
name attribute. A path to
the page that implements the tag.
• Relative path: expanded from the current page
• Absolute path: expanded using ColdFusion
mapping
A physical path is not valid.
name Required
unless
template
attribute is used
Mutually exclusive with the
template attribute. A
custom tag name, in the form "
Name.Name.Name..."
Identifies subdirectory, under the ColdFusion tag
root directory, that contains custom tag page. For
example (Windows format):
<cfmodule name = "macromedia.Forums40.
GetUserOptions">
This identifies the page GetUserOptions.cfm in the
directory CustomTags\macromedia\Forums40
under the ColdFusion root directory.