cfcomponent

Description

Creates and defines a component object; encloses functionality that you build in CFML and enclose within cffunction tags. This tag contains one or more cffunction tags that define methods. Code within the body of this tag, other than cffunction tags, is executed when the component is instantiated.

A component file has the extension CFC and is stored in any directory of an application.

A component is invoked in the following ways:

Within the cfinvoke tag in a ColdFusion page
Within a URL that calls a CFC file and passes a method name as a URL parameter
Within the cfscript tag
As a web service
From Flash code

Syntax

<cfcomponent
  extends ="anotherComponent"
  output = "yes" or "no">
  <cffunction ...>
    ...
  </cffunction> 

  <cffunction ...>
    ...
  </cffunction> 
</cfcomponent>

Attributes

Attribute Req/Opt Default Description

extends
Optional

Name of parent component from which to inherit methods and properties.

output
Optional

yes: permits component method output

no: suppresses component method output

Attribute	Req/Opt	Default	Description
extends	Optional		Name of parent component from which to inherit methods and properties.
output	Optional		yes: permits component method output no: suppresses component method output

Usage

ColdFusion processes output expressions as follows:

If "output=no", ColdFusion suppresses all output.
If "output=yes", ColdFusion evaluates all #expr# tokens as if the function body was enclosed within cfoutput tags.
If you do not specify the output attribute, you must enclose all tokens that are to be evaluated within cfoutput tags.

This tag requires an end tag.

Example

<cfcomponent>

  <cffunction name="getEmp">
     <cfquery 
name="empQuery" datasource="ExampleApps" >
       SELECT FIRSTNAME, LASTNAME, EMAIL
       FROM tblEmployees
     </cfquery>
     <cfreturn empQuery>
  </cffunction>

  <cffunction name="getDept">
    <cfquery 
name="deptQuery" datasource="ExampleApps" >
       SELECT *
       FROM tblDepartments
     </cfquery>
     <cfreturn deptQuery>
  </cffunction>
</cfcomponent>

Version 6

Comments are no longer accepted for ColdFusion MX. ColdFusion 8 is the current version.

Comments

halh said on Jul 21, 2002 at 11:04 PM :

The default value for the OUTPUT attribute is "No".

hlichtin said on Jan 9, 2003 at 1:53 PM :

The default appears to be Yes, not no.

hlichtin said on Jan 9, 2003 at 2:15 PM :

I spoke too soon. Actually, the output attribute does not exist. (It is ignored if you specify it).

Also, this page does not document the displayname and hint attributes, which allow you to enter strings for use when you display the cfc page via http (i.e., use introspection). The displayname appears in the header. The hint appears immediately below it.

RSS feed | Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/coldfusion/6/CFML_Reference/Tags-pt117.htm