Name
cfproperty
Synopsis
<cfcomponent> <cfproperty> ... </cfcomponent>
Defines a component as a complex
datatype for use in publishing web services. Multiple
cfproperty tags can be used within a single
cfcomponent tag to define the complex datatype.
The complex datatype can then be called from a CFC published as a web
service by using the name of the component containing the complex
datatype definition in the type attribute of the
CFC’s cfargument tag.
cfproperty tags must be positioned as the first
code in a cfcomponent container. If they are not,
ColdFusion throws an exception
Although cfproperty is designed for use with
web-services authoring, it can also be used to expose additional
metadata about a CFC. Besides the named attributes listed in the
“Attributes” section, you can pass
any additional desired attributes to the
cfproperty tag as user-defined attributes.
Although these attributes don’t do anything, they
are available as metadata when the component is introspected using
the GetMetaData( ) function. You may use any
attribute names you wish with the exception of those reserved by
cfproperty: name,
displayname, hint, and
type.
Attributes
-
name="property_name" The name of the property.
namemust be a static value. Required.-
displayname="display_name" Used to display a descriptive name for the property in ColdFusion MX’s Component Browser. Optional.
-
hint="text" Used to display a hint describing what the property is for in ColdFusion MX’s Component Browser. Optional. ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Read now
Unlock full access