Tags · Functions · Objects
Lucee Tag Reference
Choose a tag:
see all tags

Tag <CFPROPERTY>

Defines components as complex types that are used for web services authoring. The attributes of this tag are exposed as component metadata and are subject to inheritance rules.

Body

This tag can't have a body.

Example

	<cfproperty
		[access="string"]
		[default="string"]
		[displayname="string"]
		[getter="boolean"]
		[hint="string"]
		name="string"
		[required="boolean"]
		[setter="boolean"]
		[type="string"] ... >

Attributes

This tag has a fixed definition of attributes (see below). In addition it allowes to use any additional attribute.
Name Type Required Description
access string No The client security context from which the method can be invoked 
default string No This sets the default value on the property when the object is created. 
displayname string No A value to be displayed when using introspection to show
information about the CFC. The value appears in parentheses
following the property name. 
getter boolean No Specifies whether to generate getter methods or not 
hint string No Text to be displayed when using introspection to show
information about the CFC. This attribute can be useful
for describing the purpose of the parameter. 
name string Yes A string; a property name. Must be a static value. 
required boolean No Whether the parameter is required 
setter boolean No Specifies whether to generate setter methods or not 
type string No A string; a property type name; data type.