cfproperty

Last updated on Feb 25, 2025 | Also applies to ColdFusion

ColdFusion

Open app

CFML Reference User Guide

ColdFusion functions

ColdFusion functions by category
Functions a-b
1. Abs
2. ACos
3. AddSOAPRequestHeader
4. AddSOAPResponseHeader
5. AjaxLink
6. AjaxOnLoad
7. ApplicationStop
8. ArrayAppend
9. ArrayAvg
10. ArrayClear
11. ArrayContains
12. ArrayContainsNoCase
13. ArrayDelete
14. ArrayDeleteAt
15. ArrayDeleteNoCase
16. ArrayEach
17. ArrayFilter
18. ArrayFind
19. ArrayFindAll
20. ArrayFindAllNoCase
21. ArrayFindNoCase
22. ArrayInsertAt
23. ArrayIsDefined
24. ArrayIsEmpty
25. ArrayLen
26. ArrayMap
27. ArrayMax
28. ArrayMin
29. ArrayNew
30. ArrayPrepend
31. ArrayReduce
32. ArrayResize
33. ArraySet
34. ArraySetMetadata
35. ArraySlice
36. ArraySort
37. ArraySum
38. ArraySwap
39. ArrayToList
40. Asc
41. ASin
42. Atn
43. AuthenticatedContext
44. AuthenticatedUser
45. BinaryDecode
46. BinaryEncode
47. BitAnd
48. BitMaskClear
49. BitMaskRead
50. BitMaskSet
51. BitNot
52. BitOr
53. BitSHLN
54. BitSHRN
55. BitXor
56. BooleanFormat
Functions-c-d
Functions-e-g
Functions-h-im
Functions-in-k
Functions-l
Functions-m-r
Functions-s
Functions-t-z
1. Tan
2. ThreadJoin
3. ThreadTerminate
4. Throw
5. TimeFormat
6. ToBase64
7. ToBinary
8. ToScript
9. ToString
10. Trace
11. Transactionandconcurrency
12. TransactionCommit
13. TransactionRollback
14. TransactionSetSavePoint
15. Trim
16. UCase
17. URLDecode
18. URLEncodedFormat
19. URLSessionFormat
20. Val
21. ValueList
22. VerifyClient
23. Week
24. Wrap
25. WriteDump
26. WriteLog
27. WriteOutput
28. WSGetAllChannels
29. WSGetSubscribers
30. WSPublish
31. WSSendMessage
32. XmlChildPos
33. XmlElemNew
34. XmlFormat
35. XmlGetNodeType
36. XmlNew
37. XmlParse
38. XmlSearch
39. XmlTransform
40. XmlValidate
41. Year
42. YesNoFormat

ColdFusion tags

ColdFusion tag summary
ColdFusion tags by category
1. Application framework tags
  1. cfapplication
  2. cfassociate
  3. cferror
  4. cfimport
  5. cfinterface
  6. cflock
  7. cfscript
  8. cfthread
2. Communications tags
3. Database manipulation tags
4. Data output tags
  1. cfchart
5. Debugging tags
  1. cfdump
  2. cftimer
  3. cftrace
6. Exception handling tags
  1. cfcatch
  2. cferror
  3. cffinally
  4. cfrethrow
  5. cfthrow
  6. cftry
7. Extensibility tags
  1. cfchart
  2. cfchartdata
  3. cfchartseries
  4. cfcollection
  5. cfcomponent
  6. cfexecute
  7. cfftp
  8. function
  9. cfindex
  10. cfinterface
  11. cfinvoke
  12. cfinvokeargument
  13. cfobject
  14. cfproperty
  15. cfreport
  16. cfreportparam
  17. cfreturn
  18. cfsearch
  19. cfsharepoint
  20. cfspreadsheet
  21. cfwddx
  22. cfxml
8. File management tags
  1. cfdirectory
  2. cffile
  3. cffileupload
  4. cfftp
  5. cfzip
  6. cfzipparam
9. Flow-control tags
  1. cfabort
  2. cfbreak
  3. cfcase
  4. cfcontinue
  5. cfdefaultcase
  6. cfelse
  7. cfelseif
  8. cfexecute
  9. cfexit
  10. cfif
  11. cfinclude
  12. cflocation
  13. cfloop
  14. cfrethrow
  15. cfswitch
  16. cfthrow
  17. cftry
10. Forms tags
  1. cfapplet
  2. cfcalendar
  3. cffileupload
  4. cfform
  5. cfformgroup
  6. cfformitem
  7. cfgrid
  8. cfgridcolumn
  9. cfgridrow
  10. cfgridupdate
  11. cfinput
  12. cfpdf
  13. cfpdfform
  14. cfpdfformparam
  15. cfpdfparam
  16. cfpdfsubform
  17. cfselect
  18. cfslider
  19. cftextarea
  20. cftree
  21. cftreeitem
11. Internet Protocol tags
  1. cfajaximport
  2. cfajaxproxy
  3. cfftp
  4. cffeed
  5. cfimap
  6. cfhttp
  7. cfhttpparam
  8. cfldap
  9. cfmail
  10. cfmailparam
  11. cfmailpart
  12. cfpop
  13. cfsprydataset
12. Page processing tags
  1. cfcache
  2. cfcontent
  3. cfflush
  4. cfheader
  5. cfhtmlhead
  6. cfinclude
  7. cfprocessingdirective
  8. cfsetting
  9. cfsilent
13. Security tags
14. Variable manipulation tags
  1. cfcookie
  2. cfdump
  3. cfparam
  4. cfregistry
  5. cfsavecontent
  6. cfschedule
  7. cfset
  8. cfsetting
15. Other tags
  1. cfimage
  2. cflog
  3. cfregistry
Tags a-b
Tags c
Tags f
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
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
Tags j-l
Tags m-o
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
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
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
Tags u-z
1. cfupdate
2. cfwddx
3. cfwebsocket
4. cfwindow
5. cfxml
6. cfzip
7. cfzipparam

CFML Reference

Cloud services

CFML Reference User Guide
ColdFusion functions
ColdFusion tags
1. ColdFusion tag summary
2. ColdFusion tags by category
  1. Application framework tags
    1. cfapplication
    2. cfassociate
    3. cferror
    4. cfimport
    5. cfinterface
    6. cflock
    7. cfscript
    8. cfthread
  2. Communications tags
  3. Database manipulation tags
  4. Data output tags
    1. cfchart
  5. Debugging tags
    1. cfdump
    2. cftimer
    3. cftrace
  6. Exception handling tags
    1. cfcatch
    2. cferror
    3. cffinally
    4. cfrethrow
    5. cfthrow
    6. cftry
  7. Extensibility tags
    1. cfchart
    2. cfchartdata
    3. cfchartseries
    4. cfcollection
    5. cfcomponent
    6. cfexecute
    7. cfftp
    8. function
    9. cfindex
    10. cfinterface
    11. cfinvoke
    12. cfinvokeargument
    13. cfobject
    14. cfproperty
    15. cfreport
    16. cfreportparam
    17. cfreturn
    18. cfsearch
    19. cfsharepoint
    20. cfspreadsheet
    21. cfwddx
    22. cfxml
  8. File management tags
    1. cfdirectory
    2. cffile
    3. cffileupload
    4. cfftp
    5. cfzip
    6. cfzipparam
  9. Flow-control tags
    1. cfabort
    2. cfbreak
    3. cfcase
    4. cfcontinue
    5. cfdefaultcase
    6. cfelse
    7. cfelseif
    8. cfexecute
    9. cfexit
    10. cfif
    11. cfinclude
    12. cflocation
    13. cfloop
    14. cfrethrow
    15. cfswitch
    16. cfthrow
    17. cftry
  10. Forms tags
    1. cfapplet
    2. cfcalendar
    3. cffileupload
    4. cfform
    5. cfformgroup
    6. cfformitem
    7. cfgrid
    8. cfgridcolumn
    9. cfgridrow
    10. cfgridupdate
    11. cfinput
    12. cfpdf
    13. cfpdfform
    14. cfpdfformparam
    15. cfpdfparam
    16. cfpdfsubform
    17. cfselect
    18. cfslider
    19. cftextarea
    20. cftree
    21. cftreeitem
  11. Internet Protocol tags
    1. cfajaximport
    2. cfajaxproxy
    3. cfftp
    4. cffeed
    5. cfimap
    6. cfhttp
    7. cfhttpparam
    8. cfldap
    9. cfmail
    10. cfmailparam
    11. cfmailpart
    12. cfpop
    13. cfsprydataset
  12. Page processing tags
    1. cfcache
    2. cfcontent
    3. cfflush
    4. cfheader
    5. cfhtmlhead
    6. cfinclude
    7. cfprocessingdirective
    8. cfsetting
    9. cfsilent
  13. Security tags
  14. Variable manipulation tags
    1. cfcookie
    2. cfdump
    3. cfparam
    4. cfregistry
    5. cfsavecontent
    6. cfschedule
    7. cfset
    8. cfsetting
  15. Other tags
    1. cfimage
    2. cflog
    3. cfregistry
3. Tags a-b
4. Tags c
5. Tags f
6. 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
7. 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
8. Tags j-l
9. Tags m-o
10. 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
11. 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
12. 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
13. 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
Cloud services

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

<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 (2025 release): The default value of cfproperty can be CFML expressions. In this release , the default value of a cfproperty can be expressions. In earlier versions, only string values were allowed.
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

This attribute allows a valid CFML expression. See the example below for more information.

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>

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

</cffunction>

</cfcomponent>

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

Example 1

myprops.cfc

component accessors=true {

property name="testProp" default="test";

property name="propA" default="#[1,2,3]#";

property name="proph" type="array" default="[1,2,3].avg()";

property name="prope" type="array" default="#ArrayNew(1)#";

property name="propAA" type="any" default="#['key1':'val1']#";

property name="propF" type="struct" default="#{"id": "0001",

"type": "donut",

"name": "Cake",

"ppu": 0.55,}.append({ "id": "5001", "type": "None" })#" ;

property name="propV" type="any" default="# tval? (tval ? 'trueValue' : 'falseVal') : 'falseValue'#";

property name="propW" type="any" default="#UCase("This is a text: ") & ToString(123 + 456)#";

property name="propX" default="#fval?: 'true'#";

property name="propY" type="any" default="#originalStruct?.address?.street#";

property name="propZ" type="any" default="#originalStruct ?? 'notnullvalue'#";

property name="propAB" type="any" default=#IsStruct(originalStruct) === true#;

property name="propS" type="any" default="#x LTE y#";

property name="propK" type="string" default="#str contains substr#";

property name="propT" type="any" default="#str does not contain substr#";

x=25;

y=5*5;

originalStruct = {name = "Alice", address = {street = "123 Main St", city = "Wonderland"},

mobile = 7777777777,};

str ='Adobe'

substr= 'Ad'

tval=true

fval=false

}

component accessors=true { property name="testProp" default="test"; property name="propA" default="#[1,2,3]#"; property name="proph" type="array" default="[1,2,3].avg()"; property name="prope" type="array" default="#ArrayNew(1)#"; property name="propAA" type="any" default="#['key1':'val1']#"; property name="propF" type="struct" default="#{"id": "0001", "type": "donut", "name": "Cake", "ppu": 0.55,}.append({ "id": "5001", "type": "None" })#" ; property name="propV" type="any" default="# tval? (tval ? 'trueValue' : 'falseVal') : 'falseValue'#"; property name="propW" type="any" default="#UCase("This is a text: ") & ToString(123 + 456)#"; property name="propX" default="#fval?: 'true'#"; property name="propY" type="any" default="#originalStruct?.address?.street#"; property name="propZ" type="any" default="#originalStruct ?? 'notnullvalue'#"; property name="propAB" type="any" default=#IsStruct(originalStruct) === true#; property name="propS" type="any" default="#x LTE y#"; property name="propK" type="string" default="#str contains substr#"; property name="propT" type="any" default="#str does not contain substr#"; x=25; y=5*5; originalStruct = {name = "Alice", address = {street = "123 Main St", city = "Wonderland"}, mobile = 7777777777,}; str ='Adobe' substr= 'Ad' tval=true fval=false }

component accessors=true {
        property name="testProp" default="test";
        property name="propA" default="#[1,2,3]#";
        property name="proph" type="array" default="[1,2,3].avg()";
        property name="prope" type="array" default="#ArrayNew(1)#";   

        property name="propAA" type="any" default="#['key1':'val1']#"; 
        property name="propF" type="struct" default="#{"id": "0001",
            "type": "donut",
            "name": "Cake",
            "ppu": 0.55,}.append({ "id": "5001", "type": "None" })#" ;

        property name="propV" type="any" default="# tval? (tval ? 'trueValue' : 'falseVal') : 'falseValue'#";
        property name="propW" type="any" default="#UCase("This is a text: ") & ToString(123 + 456)#";

        property name="propX" default="#fval?: 'true'#";
        property name="propY" type="any" default="#originalStruct?.address?.street#";
        property name="propZ" type="any" default="#originalStruct ?? 'notnullvalue'#";

        property name="propAB" type="any" default=#IsStruct(originalStruct) === true#;
        property name="propS" type="any" default="#x LTE y#";

        property name="propK" type="string" default="#str contains substr#";
        property name="propT" type="any" default="#str does not contain substr#";


        x=25;
        y=5*5;
        originalStruct = {name = "Alice", address = {street = "123 Main St", city = "Wonderland"}, 
        mobile = 7777777777,};

        str ='Adobe'
        substr= 'Ad'
        tval=true
        fval=false

}

property.cfm

// Instantiate the component

componentPath = "myProps";

componentInstance = createObject("component", componentPath);

// Get metadata for the component

metadata = getComponentMetaData(componentPath);

// Loop through all functions (methods) to find getters

results = {};

for (method in metadata.functions) {

// Check if the method starts with "get" or "is" (for booleans)

if (left(method.name, 3) == "get" || left(method.name, 2) == "is") {

try {

// Dynamically call the getter method

propertyName = method.name; // getPropertyName or isPropertyName

results[propertyName] = componentInstance[propertyName]();

} catch (any e) {

results[propertyName] = "Error retrieving value: " & e.message;

}

// Dump the result of all getter method calls

writeDump(var=results, label="Getter Results");

</cfscript>

<cfscript> // Instantiate the component componentPath = "myProps"; componentInstance = createObject("component", componentPath); // Get metadata for the component metadata = getComponentMetaData(componentPath); // Loop through all functions (methods) to find getters results = {}; for (method in metadata.functions) { // Check if the method starts with "get" or "is" (for booleans) if (left(method.name, 3) == "get" || left(method.name, 2) == "is") { try { // Dynamically call the getter method propertyName = method.name; // getPropertyName or isPropertyName results[propertyName] = componentInstance[propertyName](); } catch (any e) { results[propertyName] = "Error retrieving value: " & e.message; } } } // Dump the result of all getter method calls writeDump(var=results, label="Getter Results"); </cfscript>

<cfscript>
    // Instantiate the component
    componentPath = "myProps";
    componentInstance = createObject("component", componentPath);
    
    // Get metadata for the component
    metadata = getComponentMetaData(componentPath);

    // Loop through all functions (methods) to find getters
    results = {};
    for (method in metadata.functions) {
        // Check if the method starts with "get" or "is" (for booleans)
        if (left(method.name, 3) == "get" || left(method.name, 2) == "is") {
            try {
                // Dynamically call the getter method
                propertyName = method.name; // getPropertyName or isPropertyName
                results[propertyName] = componentInstance[propertyName]();
            } catch (any e) {
                results[propertyName] = "Error retrieving value: " & e.message;
            }
        }
    }

    // Dump the result of all getter method calls
    writeDump(var=results, label="Getter Results");
</cfscript>

Get help faster and easier

New user?

cfproperty

Description

Category

Syntax

See also

History

Attributes

Usage

Example

Example 1

Get help faster and easier

Share this page

Ask the Community

Contact Us