User Guide Cancel

cfproperty

Last updated on

ColdFusion User Guide
Introduction to ColdFusion
Cloud Services in ColdFusion
Install ColdFusion
Use ColdFusion
Performance Monitoring Toolset
Adobe ColdFusion Builder extension for Visual Studio Code
Use ColdFusion Builder
Coldfusion API Manager
Configure and administer ColdFusion
ColdFusion functions
ColdFusion Tags
1. ColdFusion tags by category
2. Tags a-b
3. Tags c
  1. cfcache
  2. cfcalendar
  3. cfcase
  4. cfcatch
  5. cfchart
  6. cfchartdata
  7. cfchartseries
  8. cfclient
  9. cfclientsettings
  10. cfcol
  11. cfcollection
  12. cfcomponent
  13. cfcontent
  14. cfcontinue
  15. cfcookie
  16. Tags d-e
4. Tags f
5. Tags g-h
  1. cfgraph
  2. cfgraphdata
  3. cfgrid
  4. cfgridcolumn
  5. cfgridrow
  6. cfgridupdate
  7. cfheader
  8. cfhtmlhead
  9. cfhtmltopdf
  10. cfhtmltopdfitem
  11. cfhttp
  12. cfhttpparam
6. Tags i
  1. cfif
  2. cfimage
  3. cfimap
  4. cfimapfilter
  5. cfimpersonate
  6. cfimport
  7. cfinclude
  8. cfindex
  9. cfinput
  10. cfinsert
  11. cfinterface
  12. cfinvoke
  13. cfinvokeargument
7. Tags j-l
8. Tags m-o
9. Tags p-q
  1. cfparam
  2. cfpdf
  3. cfpdfform
  4. cfpdfformparam
  5. cfpdfparam
  6. cfpdfsubform
  7. cfpod
  8. cfpop
  9. cfpresentation
  10. cfpresentationslide
  11. cfpresenter
  12. cfprint
  13. cfprocessingdirective
  14. cfprocparam
  15. cfprocresult
  16. cfprogressbar
  17. cfproperty
  18. cfquery
  19. cfqueryparam
10. Tags r-s
  1. cfregistry
  2. cfreport
  3. cfreportparam
  4. cfrethrow
  5. cfreturn
  6. cfsavecontent
  7. cfschedule
  8. cfscript
  9. cfsearch
  10. cfselect
  11. cfservlet
  12. cfservletparam
  13. cfset
  14. cfsetting
  15. cfsharepoint
  16. cfsilent
  17. cfslider
  18. cfspreadsheet
  19. cfsprydataset
  20. cfstoredproc
  21. cfswitch
11. Tags t
  1. cftable
  2. cftextarea
  3. cftextinput
  4. cfthread
  5. cfthrow
  6. cftimer
  7. cftooltip
  8. cftrace
  9. cftransaction
  10. cftree
  11. cftreeitem
  12. cftry
12. Tags u-z
  1. cfupdate
  2. cfwddx
  3. cfwebsocket
  4. cfwindow
  5. cfxml
  6. cfzip
  7. cfzipparam
CFML Reference
1. Reserved words and variables
2. Ajax JavaScript functions
3. ColdFusion ActionScript functions
4. ColdFusion mobile functions
5. Application.cfc reference
6. Script functions implemented as CFCs
7. ColdFusion Flash Form style reference
8. ColdFusion event gateway reference
9. ColdFusion C++ CFX Reference
10. ColdFusion Java CFX reference
11. WDDX JavaScript Objects
Develop ColdFusion applications
1. Introducing ColdFusion
2. Changes in ColdFusion
3. Introduction to application development
4. The CFML programming language
5. Building blocks of ColdFusion applications
6. Develop CFML applications
7. Develop mobile applications
8. Access and use data
9. ColdFusion ORM
10. ColdFusion and HTML5
11. Flex and AIR integration in ColdFusion
12. Request and present information
13. Office file interoperability
14. ColdFusion portlets
15. Work with documents, charts, and reports
16. Use web elements and external objects
17. Use external resources

Description

Defines properties and their annotations for a ColdFusion component (CFC). The properties are used to create complex data types for web services, while the annotations are used to define Object Relational Model (ORM) for a CFC. The attributes of this tag are exposed as component metadata and are subject to inheritance rules.

Syntax

<cfproperty 
name="name" 
default="default value" 
displayname="descriptive name" 
hint="extended description" 
required="false|true" 
serializable="true|false" 
type="type">

Note:

For ORM-related attributes and their usage, see Map the properties in the Developing ColdFusion Applications.

History

ColdFusion 9: Added attributes for defining Object Relational Model for the CFC.Added implicit getters and setters. Added validate and validateparams attributes.

ColdFusion MX: Added this tag.

Attributes

Attribute

Req/Opt

Default

Description

batchsize

For information about these attributes, see ColdFusion ORM.

cascade

catalog

cfc

collectiontype

column

constrained

datatype

default

Optional

If no property value is set when the component is used for a web service, specifies a default value. If this attribute is present, the required attribute must be set to no or not specified.
For ORM-specific usage of the default attribute, see ColdFusion ORM.

displayname

Optional

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

dynamicInsert

For information about these attributes, see ColdFusion ORM.

dynamicupdate

elementColumn

elementtype

entityname

fetchbatchsize

fieldType

fkcolumn

formula

generator

getter

Optional

Specifies whether to generate getter methods or not. Value are:

true
false

hint

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.

index

For information about these attributes, see ColdFusion ORM.

insert

inverse

inversejoincolumn

joincolumn

lazy

length

linkcatalog

linkschema

linktable

mappedby

missingrowIgnored

name

Required

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

notnull

For information about these attributes, see ColdFusion ORM.

optimisticLock

optimisticLockgenerated

orderby

orderByreadonly

params

For information about these attributes, see ColdFusion ORM.

persistent

preceision

readonly

required

Optional

Whether the parameter is required:

rowid

For information about these attributes, see ColdFusion ORM.

scale

setter

Specifies whether to generate setter methods or not. Possible values are:

true
false

schema

For information about these attributes, see ColdFusion ORM.

selectbeforeupdate

selectkey

sequence

serializable

Optional

true

Specifies whether this property can be serialized. If you set this value to false, the property cannot be serialized, so any changes made are not retained on session replication, and the property has its default value (if any) on the second server. Use this attribute to prevent serializaton of properties in CFCs that are serializable.

source

For information about these attributes, see ColdFusion ORM.

structkeycolumn

structkeydatatype

structkeyType

table

type

Optional

any

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.

unique

For information about these attributes, see ColdFusion ORM.

uniquekey

update

where

validate

Optional

For more information, see Validate and validateparams attributes in Functions.

validateparam

Optional

Usage

You must position cfproperty tags at the beginning of a component, above executable code and function definitions. If a component is not used as a web service, <cfproperty> only provides metadata information of the property. It does not define variables or set values that you can use in your component. However, it creates implicit setters and getters for the property in the CFC depending on whether getter/setter attributes are enabled. For details, see Implicit Get and Set Functions in Developing ColdFusion Applications.
For Object Relational Model (ORM), cfproperty is used to define relational mapping for the property of the CFC. For details, see ColdFusion ORM in Developing ColdFusion Applications.
For web services that you create in ColdFusion, the cfproperty tag defines complex variables used by the web service.

Example

The following code defines a component in the file address.cfc that contains properties that represent a street address:

<cfcomponent> 
<cfproperty name="Number" type="numeric"> 
<cfproperty name="Street" type="string"> 
<cfproperty name="City" type="string"> 
<cfproperty name="State" type="string"> 
<cfproperty name="Country" type="string"> 
</cfcomponent>

This component represents a complex data type that can be used in a component that is exported as a web service, such as the following:

<cfcomponent> 
<cffunction name="echoAddress" returnType="address" access="remote"> 
<cfargument name="input" type="address"> 
<cfreturn arguments.input> 
</cffunction> 
</cfcomponent>

cfproperty

Description

Category

Syntax

See also

History

Attributes

Usage

Example

Ask the Community

Contact Us