`checkBoxTag()`

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.

Function Syntax

checkBoxTag(name [, checked, value, uncheckedValue, label, labelPlacement, prepend, append, prependToLabel, appendToLabel ])

Parameters

Parameter	Type	Required	Default	Description
`name`	`string`	Yes		Name to populate in tag's `name` attribute.
`checked`	`boolean`	No	`false`	Whether or not the check box should be checked by default.
`value`	`string`	No	`1`	Value of check box in its `checked` state.
`uncheckedValue`	`string`	No		The value of the check box when it's on the `unchecked` state.
`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

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