<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.

This tag cannot have a body.

This tag is also supported within <cfscript>

Attribute Description
default
string, optional

This sets the default value on the property when the object is created.

access
string, optional

The client security context from which the method can be invoked

required
boolean, optional

Whether the parameter is required

hint
string, optional

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.

displayname
string, optional

A value to be displayed when using introspection to show information about the CFC. The value appears in parentheses following the property name.

name
string, required

A string; a property name. Must be a static value.

type
string, optional

A string; a property type name; data type.

getter
boolean, optional

Specifies whether to generate getter methods or not

setter
boolean, optional

Specifies whether to generate setter methods or not

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

Examples

There are currently no examples for this tag.

See also