Checkbox Question Schema Properties
A question that allows respondents to select multiple options from a list.
Element type: checkbox
Key properties: 18
Generation Hints
Section titled “Generation Hints”- Aliases: multi-select, checklist, checkboxes.
- Use when: respondents can choose more than one option.
- Recommended properties:
type,name,title,choices,showOtherItem,validators,isRequired.
{ "type": "checkbox", "name": "features", "title": "Which features do you need?", "choices": ["Approvals", "Exports", "Notifications"] }Key Properties
Section titled “Key Properties”choices
Section titled “choices”- Type:
checkboxitem[] - Default:
[]
Gets or sets choice items. This property accepts an array of objects with the following structure:
choicesByUrl
Section titled “choicesByUrl”- Type:
restfull - Default:
—
Configures access to a RESTful service that returns choice items. Refer to the ChoicesRestful class description for more information. You can also specify additional application-wide settings using the settings.web object.
choicesFromQuestion
Section titled “choicesFromQuestion”- Type:
question_carryforward - Default:
—
Copies choice items from a specified question. Accepts a question name.
choicesFromQuestionMode
Section titled “choicesFromQuestionMode”- Type:
string - Default:
"all" - Allowed values:
all,selected,unselected
Specifies which choice items to copy from another question. Applies only when the choicesFromQuestion property is specified.
choicesVisibleIf
Section titled “choicesVisibleIf”- Type:
condition - Default:
—
A Boolean expression that is evaluated against each choice item. If the expression evaluates to false, the choice item becomes hidden.
choicesEnableIf
Section titled “choicesEnableIf”- Type:
condition - Default:
—
A Boolean expression that is evaluated against each choice item. If the expression evaluates to false, the choice item becomes read-only.
choicesOrder
Section titled “choicesOrder”- Type:
string - Default:
"none" - Allowed values:
none,asc,desc,random
Specifies the sort order of choice items.
colCount
Section titled “colCount”- Type:
number - Default:
1 - Allowed values:
0,1,2,3,4,5
Gets or sets the number of columns used to arrange choice items.
showSelectAllItem
Section titled “showSelectAllItem”- Type:
boolean - Default:
—
Enable this property to display a “Select All” item. When users select it, all other choice options, except special options, also become selected.
selectAllText
Section titled “selectAllText”- Type:
string - Default:
— - Localizable: Yes
Gets or sets a caption for the “Select All” choice item.
showOtherItem
Section titled “showOtherItem”- Type:
boolean - Default:
—
Specifies whether to display the “Other” choice item.
showNoneItem
Section titled “showNoneItem”- Type:
boolean - Default:
—
Specifies whether to display the “None” choice item.
showCommentArea
Section titled “showCommentArea”- Type:
switch - Default:
—
Specifies whether to display a comment area.
separateSpecialChoices
Section titled “separateSpecialChoices”- Type:
boolean - Default:
—
Displays the “Select All”, “None”, and “Other” choices on individual rows.
minSelectedChoices
Section titled “minSelectedChoices”- Type:
number - Default:
0
Specifies the minimum number of selected choices.
maxSelectedChoices
Section titled “maxSelectedChoices”- Type:
number - Default:
0
Specifies the maximum number of selected choices.
valuePropertyName
Section titled “valuePropertyName”- Type:
string - Default:
—
Specifies a property name used to store selected values.
hideIfChoicesEmpty
Section titled “hideIfChoicesEmpty”- Type:
boolean - Default:
—
Specifies whether to hide the question if no choice items are visible.
Shared Properties
Section titled “Shared Properties”This page lists only properties that are specific to this element type or especially important for generation.
- Use Shared Question Properties for common fields such as
name,title,description,isRequired,requiredIf,visibleIf,enableIf,readOnly,defaultValue,validators,width, and layout options. - Use Shared Choice Question Properties for shared choice fields such as
choices,choicesByUrl,choicesFromQuestion,showOtherItem,showNoneItem, and special choice labels. - Use Choice Item for object choices and Choices By URL for remote choice loading.