You are viewing documentation for v1.0.x. Change

select()

Description

Builds and returns a string containing a select form control based on the supplied objectName and property.

Function Syntax

select(objectName, property, options [, includeBlank, valueField, textField, label, labelPlacement, prepend, append, prependToLabel, appendToLabel, errorElement ])

Parameters

Parameter Type Required Default Description
objectName any Yes The variable name of the object to build the form control for.
property string Yes The name of the property to use in the form control.
options any Yes A collection to populate the select form control with. Can be a query recordset or an array of objects.
includeBlank any No false Whether to include a blank option in the select form control. Pass true to include a blank line or a string that should represent what display text should appear for the empty value (for example, "- Select One -").
valueField string No The column or property to use for the value of each list element. Used only when a query or array of objects has been supplied in the options argument.
textField string No The column or property to use for the value of each list element that the end user will see. Used only when a query or array of objects has been supplied in the options argument.
label string No The label text to use in the form control.
labelPlacement string No around Whether to place the label before, after, or wrapped around the form control.
prepend string No String to prepend to the form control. Useful to wrap the form control around HTML tags.
append string No String to append to the form control. Useful to wrap the form control around HTML tags.
prependToLabel string No String to prepend to the form control's label. Useful to wrap the form control around HTML tags.
appendToLabel string No String to append to the form control's label. Useful to wrap the form control around HTML tags.
errorElement string No span HTML tag to wrap the form control with when the object contains errors.

Examples

<!--- controller code --->
<cfset authors = model("author").findAll()>

<!--- view code --->
<cfoutput>
<p>#select(objectName="book", property="authorId", options=authors)#</p>
</cfoutput>