ColdFusion Tags

ColdFusion Markup Language (CFML) includes a set of tags that you use in Macromedia ColdFusion MX 7 pages to interact with data sources, manipulate data, and display output. CFML tag syntax is similar to HTML element syntax.

This chapter contains categorized and alphabetical lists of the tags followed by the detailed tag descriptions.

Contents

Tag summary
Tags by function
Tag changes since ColdFusion 5
Tag descriptions

The following table briefly describes CFML tags:

CFML tag Category Description

cfabort

Flow-control tags

Stops the processing of a ColdFusion page at the tag location

cfapplet

Forms tags

Embeds Java applets in a cfform tag

cfapplication

Application framework tags

Defines an application name; activates client variables; specifies client variable storage mechanism

cfargument

Extensibility tags

Creates a parameter definition within a component definition; defines a function argument

cfassociate

Application framework tags

Enables subtag data to be saved with a base tag

cfbreak

Flow-control tags

Breaks out of a CFML looping construct

cfcache

Page processing tags

Caches ColdFusion pages

cfcalendar

Forms tags

Provides a calendar from which to select a date

cfcase

Flow-control tags

Used with the cfswitch and cfdefaultcase tags

cfcatch

Exception handling tags,
Flow-control tags

Catches exceptions in ColdFusion pages

cfchart

Data output tags

Generates and displays a chart

cfchartdata

Data output tags

Defines chart data points

cfchartseries

Data output tags

Defines style in which chart data displays

cfcol

Data output tags

Defines table column header, properties

cfcollection

Extensibility tags

Administers Verity collections

cfcomponent

Extensibility tags

Creates and defines a component object

cfcontent

Data output tags,
Page processing tags

Defines content type and filename of a file to be downloaded by current page

cfcookie

Variable manipulation tags

Defines and sets cookie variables, including expiration and security options

cfdefaultcase

Flow-control tags

Receives control if there is no matching cfcase tag value

cfdirectory

File management tags

Performs typical directory-handling tasks from within a ColdFusion application

cfdocument

Data output tags

Creates PDF or FlashPaper output from a text block containing CFML and HTML

cfdocumentitem

Data output tags

Specifies action items, such as header, footer, and page break, for a PDF or FlashPaper document

cfdocumentsection

Data output tags

Divides a PDF or FlashPaper document into sections

cfdump

Debugging tags,
Variable manipulation tags

Outputs variables for debugging

cfelse

Flow-control tags

Creates IF-THEN-ELSE constructs

cfelseif

Flow-control tags

Creates IF-THEN-ELSE constructs

cferror

Exception handling tags,
Application framework tags

Displays custom HTML error pages when errors occur

cfexecute

Flow-control tags,
Extensibility tags

Executes developer-specified process on server computer

cfexit

Flow-control tags

Aborts processing of executing CFML tag

cffile

File management tags

Performs typical file-handling tasks from within ColdFusion application

cfflush

Data output tags,
Page processing tags

Flushes currently available data to client

cfform

Forms tags

Builds input form; performs client-side input validation

cfformgroup

Forms tags

Groups form control into a containing object

cfformitem

Forms tags

Adds text and dividing rules to Flash forms

cfftp

Forms tags,
Extensibility tags,
Internet Protocol tags

Permits FTP file operations

cffunction

Extensibility tags

Defines function that you build in CFML

cfgrid

Forms tags

Displays tabular grid control, in cfform tag

cfgridcolumn

Forms tags

Used in cfform; defines columns in a cfgrid

cfgridrow

Forms tags

Defines a grid row; used with cfgrid

cfgridupdate

Forms tags

Directly updates ODBC data source from edited grid data

cfheader

Data output tags,
Page processing tags

Generates HTTP headers

cfhtmlhead

Page processing tags

Writes text and HTML to HEAD section of page

cfhttp

Internet Protocol tags

Performs GET and POST to upload file or post form, cookie, query, or CGI variable directly to server

cfhttpparam

Internet Protocol tags

Specifies parameters required for a cfhttp POST operation; used with cfhttp

cfif

Flow-control tags

Creates IF-THEN-ELSE constructs

cfimport

Application framework tags

Imports JSP tag libraries into a CFML page

cfinclude

Flow-control tags

Embeds references to ColdFusion pages

cfindex

Extensibility tags

Creates Verity search indexes

cfinput

Forms tags

Creates an input element (radio button, check box, text entry box); used in cfform

cfinsert

Database manipulation tags

Inserts records in a data source

cfinvoke

Extensibility tags

Invokes component methods from a ColdFusion page or component

cfinvokeargument

Extensibility tags

Passes a parameter to a component method or a web service

cfldap

Internet Protocol tags

Provides access to LDAP directory servers

cflocation

Flow-control tags

Controls execution of a page

cflock

Application framework tags

Ensures data integrity and synchronizes execution of CFML code

cflog

Data output tags,
Other tags

Writes a message to a log file

cflogin

Security tags

Defines a container for user login and authentication code

cfloginuser

Security tags

Identifies an authenticated user to ColdFusion

cflogout

Security tags

Logs the current user out

cfloop

Flow-control tags

Repeats a set of instructions based on conditions

cfmail

Internet Protocol tags

Assembles and posts an e-mail message

cfmailparam

Internet Protocol tags

Attaches a file or adds a header to an e-mail message

cfmailpart

Internet Protocol tags

Contains one part of a multi-part mail message

cfmodule

Application framework tags

Invokes a custom tag for use in a ColdFusion page

cfNTauthenticate

Security tags

Authenticates user information against an NT domain

cfobject

Extensibility tags

Creates COM, component, CORBA, Java, and web service objects

cfobjectcache

Database manipulation tags

Flushes the query cache

cfoutput

Data output tags

Displays the output of a database query or other operation

cfparam

Variable manipulation tags

Defines a parameter and its default value

cfpop

Internet Protocol tags

Gets and deletes messages from POP mail server

cfprocessingdirective

Data output tags

Suppresses white space and other output

cfprocparam

Database manipulation tags

Holds parameter information for stored procedure

cfprocresult

Database manipulation tags

Result set name that ColdFusion tags use to access result set of a stored procedure

cfproperty

Extensibility tags

Defines components

cfquery

Database manipulation tags

Passes SQL statements to a database

cfqueryparam

Database manipulation tags

Checks data type of a query parameter

cfregistry

Other tags,
Variable manipulation tags

Reads, writes, and deletes keys and values in a Windows system registry

cfreport

Exception handling tags

Embeds a ColdFusion Report Builder or Crystal Reports report

cfreportparam

Exception handling tags

Passes an input parameter to a ColdFusion Report Builder report

cfrethrow

Exception handling tags

Rethrows currently active exception

cfreturn

Extensibility tags

Returns results from a component method

cfsavecontent

Variable manipulation tags

Saves generated content inside tag body in a variable

cfschedule

Variable manipulation tags

Schedules page execution; optionally, produces static pages

cfscript

Application framework tags

Encloses a set of cfscript statements

cfsearch

Extensibility tags

Executes searches against data indexed in Verity collections, using cfindex

cfselect

Forms tags

Creates a drop-down list box form element; used in cfform tag

cfset

Variable manipulation tags

Defines a variable

cfsetting

Other tags,
Variable manipulation tags

Defines and controls ColdFusion settings

cfsilent

Data output tags,
Page processing tags

Suppresses CFML output within tag scope

cfslider

Forms tags

Creates slider control; used in cfform

cfstoredproc

Database manipulation tags

Holds database connection information; identifies a stored procedure to execute

cfswitch

Flow-control tags

Evaluates passed expression; passes control to matching cfcase tag

cftable

Data output tags

Builds a table in a ColdFusion page

cftextarea

Forms tags

Puts a multiline text box in a form

cfthrow

Exception handling tags,
Flow-control tags

Throws a developer-specified exception

cftimer

Debugging tags

Displays execution time for a block of code

cftrace

Debugging tags

Displays and logs application debugging data

cftransaction

Database manipulation tags

Groups cfquery operations into one transaction; performs rollback processing

cftree

Forms tags

Creates tree control element; used in cfform

cftreeitem

Forms tags

Populates a tree control element in a form; used with cftree

cftry

Exception handling tags,
Flow-control tags

Catches exceptions in ColdFusion pages

cfupdate

Database manipulation tags

Updates rows in a database data source

cfwddx

Extensibility tags

Serializes and de-serializes CFML data structures to XML-based WDDX format

cfxml

Extensibility tags

Creates an XML document object


View comments in LiveDocs