Tagbox Question Schema Properties
A multi-select dropdown (tag box) that allows selecting multiple items with search.
Element type: tagbox
Key properties: 20
Generation Hints
Section titled “Generation Hints”- Aliases: multi-select dropdown, tags input, token selector.
- Use when: respondents can choose multiple options from a long list.
- Recommended properties:
type,name,title,choices,choicesByUrl,placeholder,isRequired.
{ "type": "tagbox", "name": "skills", "title": "Skills", "choices": ["Design", "Development", "Operations"] }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.
allowClear
Section titled “allowClear”- Type:
boolean - Default:
true
Specifies whether to display a button that clears the selected value.
allowCustomChoices
Section titled “allowCustomChoices”- Type:
boolean - Default:
false
Specifies whether users can add their own choices if the desired option isn’t available in the dropdown.
placeholder
Section titled “placeholder”- Type:
string - Default:
— - Localizable: Yes
A text displayed in the input field when it doesn’t have a value.
searchEnabled
Section titled “searchEnabled”- Type:
boolean - Default:
true
Specifies whether users can enter a value into the input field to filter the drop-down list.
searchMode
Section titled “searchMode”- Type:
string - Default:
"contains" - Allowed values:
contains,startsWith
Specifies a comparison operation used to filter the drop-down list. Applies only if searchEnabled is true.
closeOnSelect
Section titled “closeOnSelect”- Type:
boolean - Default:
—
Specifies whether to close the drop-down menu after a user selects a value.
hideSelectedItems
Section titled “hideSelectedItems”- Type:
boolean - Default:
false
Specifies whether to remove selected items from the drop-down list.
textWrapEnabled
Section titled “textWrapEnabled”- Type:
boolean - Default:
true
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.
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.
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.