cfproperty
Description
Defines properties of a ColdFusion component (CFC). Used to create complex data types for web
services. The attributes of this tag are exposed as component metadata and are subject to
inheritance rules.
Category
Extensibility tags
Syntax
<cfproperty
name="name"
type="type"
required="boolean"
default="default value"
displayname="descriptive name"
hint="extended description"
>
cfargument, cfcomponent, cffunction, cfinvoke, cfinvokeargument, cfobject,
cfreturn
History
ColdFusion MX: Added this tag.
Attributes
Attribute
Req/Opt Default Description
name
Required
type
Optional any
280
Chapter 2: ColdFusion Tags
A string; a property name. Must be a static value.
A string; identifies the property data type:
any
array
binary
boolean
date
guid: The argument must be a UUID or GUID of the form
xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx where each x is a character
representing a hexadecimal number (0-9A-F).
numeric
query
string
struct
uuid: The argument must be a ColdFusion UUID of the form
xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx where each x is a character
representing a hexadecimal number (0-9A-F).
variableName: a string formatted according to ColdFusion
variable naming conventions..
a component name: If the type attribute value is not one of the
preceding items, ColdFusion treats it as the name of a
ColdFusion component. When The function executes, it
generates an error if the argument that is passed in is not a CFC
with the specified name.