textArea()

Signature

textArea() — returns any

Description

Builds and returns a string containing a text area field form control based on the supplied objectName and property. Note: Pass any additional arguments like class, rel, and id, and the generated tag will also include those values as HTML attributes.

Parameters

Name	Type	Required	Default	Description
objectName	any	yes	—	See documentation for textField.
property	string	yes	—	See documentation for textField.
association	string	yes	—	See documentation for textfield.
position	string	yes	—	See documentation for textfield.
label	string	yes	useDefaultLabel	See documentation for textField.
labelPlacement	string	yes	around	See documentation for textField.
prepend	string	yes	—	See documentation for textField.
append	string	yes	—	See documentation for textField.
prependToLabel	string	yes	—	See documentation for textField.
appendToLabel	string	yes	—	See documentation for textField.
errorElement	string	yes	span	See documentation for textField.
errorClass	string	yes	fieldWithErrors	See documentation for textField.

Examples

<!--- Provide `label` and required `objectName` and `property` --->
<cfoutput>
    #textArea(label="Overview", objectName="article", property="overview")#
</cfoutput>

<!--- Display fields for photos provided by the `screenshots` association and nested properties --->
<fieldset>
	<legend>Screenshots</legend>
	<cfloop from="1" to="#ArrayLen(site.screenshots)#" index="i">
		#fileField(label="File #i#", objectName="site", association="screenshots", position=i, property="file")#
		#textArea(label="Caption ####i##", objectName="site", association="screenshots", position=i, property="caption")#
	</cfloop>
</fieldset>