User Guide

cfmodule 251
Usage
To name a ColdFusion page that contains the custom tag definition, including its path, use the
template attribute. To refer to the custom tag in the ColdFusion installation directory, using dot
notation to indicate its location, use the
name attribute.
On UNIX systems, ColdFusion searches first for a file with a name that matches the
name
attribute, but is all lower case. If it does not find the file, it looks for a file name that matches the
attribute with identical character casing.
You can use
attributeCollection and attribute_name in the same call.
Within the custom tag code, the attributes passed with
attributeCollection are saved as
independent attribute values, with no indication that they are grouped into a structure by the
custom tag’s caller.
Similarly, if the custom tag uses a
cfassociate tag to save its attributes, the attributes passed
with
attributeCollection are saved as independent attribute values, with no indication that
they are grouped into a structure by the custom tag’s caller.
Example
<h3>cfmodule Example</h3>
<p>This view-only example shows use of cfmodule to call a custom tag inline.</
p>
<p>This example uses a sample custom tag that is saved in myTag.cfm in
the snippets directory. You can also save ColdFusion custom tags in the
Cfusion\CustomTags directory.
<cfset attrCollection1 = StructNew()>
<cfparam name="attrCollection1.value1" default="22">
<cfparam name="attrCollection1.value2" default="45">
<cfparam name="attrcollection1.value3" default="88">
<!--- Call the tag with CFMODULE with Name--->
<cfmodule
Template="myTag.cfm"
X="3"
attributeCollection=#attrCollection1#
Y="4">
<!--- show the code --->
<HR size="2" color="#0000A0">
<P>Here is one way in which to invoke the custom tag,
using the TEMPLATE attribute.</P>
<cfoutput>#HTMLCodeFormat(" <CFMODULE
Template=""myTag.cfm""
X=3
attributeCollection=##attrCollection1##
Y=4>")#
</cfoutput>
<P>The result: <cfoutput>#result#</cfoutput>
<!--- Call the tag with CFMODULE with Name--->
attributeCollection Optional Structure. A collection of key-value pairs that
represent attribute names and values. You can
specify multiple key-value pairs. You can specify this
attribute only once.
attribute_name Optional Attribute for a custom tag. You can include multiple
instances of this attribute to specify the parameters
of a custom tag.
Attribute Req/Opt Default Description