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 method is invoked in the following ways:
cfinvoke
tag in a ColdFusion pagecfscript
tag<cfcomponent
extends ="anotherComponent"
output = "yes" or "no"
displayname = "text string">
hint = "text string"> variable declarations
<cffunction ...>
...
</cffunction>
<cffunction ...>
...
</cffunction>
</cfcomponent>
cfargument
,
cffunction
,
cfinvoke
,
cfinvokeargument
,
cfobject
,
cfproperty
,
cfreturn
,
Building and Using ColdFusion Components in Developing ColdFusion MX Applications
Attribute | Req/Opt | Default | Description |
---|---|---|---|
extends |
Optional |
|
Name of parent component from which to inherit methods and properties. |
output |
Optional |
Component body displayable text is processed as standard CFML |
Specifies whether constructor code in the component can generate HTML output; does not affect output in the body of
|
displayname |
Optional |
|
A string to be displayed when using introspection to show information about the CFC. The information appears on the heading, following the component name. |
hint |
Optional |
|
Text to be displayed when using introspection to show information about the CFC. The |
If you specify the extends
attribute, the data and methods of the parent component are available to any as if they were parts of the current component. If the managerCFC component extends the employeeCFC component, and the employeeCFC component has a getEmployeeName method, you can call this method using the managerCFC, as follows:
<cfinvoke component="managerCFC" method="getEmployeeName" returnVariable="managerName" EmployeeID=#EmpID#>
This tag requires an end tag.
<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>