checkBoxTag()

Signature

checkBoxTag() — returns string

Available in: controller Category: Form Tag Functions

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	—	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. Label text placement can be controlled using aroundLeft or aroundRight.
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.
encode	any	no	true	Use this argument to decide whether the output of the function should be encoded in order to prevent Cross Site Scripting (XSS) attacks. Set it to true to encode all relevant output for the specific HTML element in question (e.g. tag content, attribute values, and URLs). For HTML elements that have both tag content and attribute values you can set this argument to attributes to only encode attribute values and not tag content.

Examples

1. Basic checkbox
#checkBoxTag(name="subscribe", value="true", label="Subscribe to our newsletter", checked=false)#

2. Checkboxes generated from a query
// Controller code
pizza = model("pizza").findByKey(session.pizzaId);
selectedToppings = pizza.toppings();
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>