`selectTag()`

Description

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

Function Syntax

selectTag(name, options [, selected, includeBlank, multiple, valueField, textField, label, labelPlacement, prepend, append, prependToLabel, appendToLabel ])

Parameters

Parameter	Type	Required	Default	Description
`name`	`string`	Yes		Name to populate in tag's `name` attribute.
`options`	`any`	Yes		A collection to populate the select form control with. Can be a query recordset or an array of objects.
`selected`	`string`	No		Value of option that should be selected by default.
`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 -").
`multiple`	`boolean`	No	`false`	Whether to allow multiple selection of options in the select form control.
`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 with HTML tags.
`append`	`string`	No		String to append to the form control. Useful to wrap the form control with HTML tags.
`prependToLabel`	`string`	No		String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags.
`appendToLabel`	`string`	No		String to append to the form control's `label`. Useful to wrap the form control with HTML tags.

Examples

<!--- Controller code --->
<cfset cities = model("city").findAll()>

<!--- View code --->
<cfoutput>
    #selectTag(name="cityId", options=cities)#
</cfoutput>

<!--- Do this when Wheels isn't grabbing the correct values for the `option`s' values and display texts --->
<cfoutput>
    #selectTag(name="cityId", options=cities, valueField="id", textField="name")#
</cfoutput>