checkBoxTag()

Signature

checkBoxTag() — returns any

Description

Builds and returns a string containing a check box form control based on the supplied name. 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
name	string	yes	—	See documentation for textFieldTag.
checked	boolean	yes	false	Whether or not the check box should be checked by default.
value	string	yes	1	Value of check box in its checked state.
uncheckedValue	string	yes	—	The value of the check box when it’s on the unchecked state.
label	string	yes	—	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.

Examples

<!--- Example 1: Basic usage involves a `label`, `name`, and `value` --->
<cfoutput>
    #checkBoxTag(name="subscribe", value="true", label="Subscribe to our newsletter", checked=false)#
</cfoutput>

<!--- Example 2: Loop over a query to display choices and whether or not they are checked --->
<!--- - Controller code --->
<cfset pizza = model("pizza").findByKey(session.pizzaId)>
<cfset selectedToppings = pizza.toppings()>
<cfset toppings = model("topping").findAll(order="name")>

<!--- View code --->
<fieldset>
	<legend>Toppings</legend>
	<cfoutput query="toppings">
		#checkBoxTag(name="toppings", value="true", label=toppings.name, checked=YesNoFormat(ListFind(ValueList(selectedToppings.id), toppings.id))#
	</cfoutput>
</fieldset>