Check Box Builder

 

In this topic ... Quick Tips Specifying Inputs

Use the Check Box builder to create a single check box on a page.

If you are replacing a check box defined on the page with a Check Box builder, make sure the chosen control tag in the original HTML has a "value" attribute that is set as required for a given source.

For example, if you specify the default value of this check box to be the result of a service call and the service call returns "on" or "off," then the <INPUT> tag in the original HTML needs its value attribute set to "on" as follows:

 <INPUT type="checkbox" name="my_checkbox" value="on">

In this case, if the source service call returns "on," then the check box will be set to "checked," otherwise it will be set to "unchecked."

 

Quick Tips

• Enabling check boxes -- To enable the check box when the page is first displayed, set the "Default Value" equal to the "Checked Value". If you do not enter a "Checked Value", we can specify "true" for the default value.

• Returning check box values -- To ensure that the check box always returns a value, be sure to set the "Checked Value" and the "Unchecked Value" for a check box builder.

 

Specifying Inputs

The Check Box builder takes the inputs described in the table below. For help on inputs common to many or all builders such as those in the Properties and HTML Attributes input groups, see "Using the Builder Call Editor."

Input Name	Description
Name	Enter a name for this builder call. The Designer displays this name in the Builder Call List.
Page Location	Use the Page Location input to specify the page or pages on which this builder call will act. See "Locating Control Builders on Pages" for detailed documentation about the Page Location input and page location syntax.
Label	Specify a label for the check box.
Default Value	Specify the default value for the check box. If you are using the default Checked and Unchecked values, specify "true" to display the check box as "checked."  If you have specified values for the Checked Value and Unchecked Value settings, this setting must match one of those.
Checked Value	(Default is "true".) Specify the value for the check box when it is "checked." This can be any text value that you want passed when the form containing this check box is submitted.
Unchecked Value	(Default is "false".) Specify the value for the check box when it is "unchecked." This can be any text value that you want passed when the form containing this check box is submitted.
Advanced - Dynamic Name	Enter an indirect (alternate) name to be used for this builder when multiple Check Box builders are included in a repeated region. When used within a repeated region, other input-control builders can have their names changed by an attribute setter. This allows multiple instances of the same builder to exist within the repeated region. The Check Box builder cannot accept an attribute setter, however, and thus specify a "Dynamic Name" for the builder when it is to be used within a repeated region.