Class CheckboxItem
Page Summary
CheckboxItem allows respondents to select one or more checkboxes with an optional "other" field.
You can add a new checkbox item to a form using
form.addCheckboxItem().Methods are available to manage choices, feedback, help text, and validation for the checkbox item.
You can set the title and options for the checkbox item using methods like
setTitle()andsetChoices().Checkbox items can be set as required and configured to show an "other" option.
A question item that allows the respondent to select one or more checkboxes, as well as anoptional "other" field. Items can be accessed or created from aForm. When used in aquiz, these items are autograded.
// Open a form by ID and add a new checkbox item.constform=FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');constitem=form.addCheckboxItem();item.setTitle('What condiments would you like on your hot dog?').setChoices([item.createChoice('Ketchup'),item.createChoice('Mustard'),item.createChoice('Relish'),]).showOtherOption(true);
Methods
| Method | Return type | Brief description |
|---|---|---|
clear | Checkbox | Removes any data validation for this checkbox item. |
create | Choice | Creates a new choice. |
create | Choice | Creates a new choice. |
create | Item | Creates a newItem for this checkbox item. |
duplicate() | Checkbox | Creates a copy of this item and appends it to the end of the form. |
get | Choice[] | Gets all choices for an item. |
get | Quiz | Returns the feedback that is shown to respondents when they respond correctly to a question. |
get | Quiz | Returns the feedback that is shown to respondents when they respond incorrectly to a question. |
get | String | Gets the item's help text (sometimes called description text for layout items likeImage,Page, andSection). |
get | Integer | Gets the item's unique identifier. |
get | Integer | Gets the index of the item among all the items in the form. |
get | Integer | Returns the point value of a gradeable item. |
get | String | Gets the item's title (sometimes called header text, in the case of aSection). |
get | Item | Gets the item's type, represented as anItem. |
has | Boolean | Determines whether the item has an "other" option. |
is | Boolean | Determines whether the respondent must answer the question. |
set | Checkbox | Sets the choices for an item from an array of strings. |
set | Checkbox | Sets an array of choices for an item. |
set | Checkbox | Sets the feedback to be shown to respondents when they respond correctly to a question. |
set | Checkbox | Sets the feedback to be shown to respondents when they respond incorrectly to a question. |
set | Checkbox | Sets the item's help text (sometimes called description text for layout items likeImage,Page, andSection). |
set | Checkbox | Sets the number of points a gradeable item is worth. |
set | Checkbox | Sets whether the respondent must answer the question. |
set | Checkbox | Sets the item's title (sometimes called header text, in the case of aSection). |
set | Checkbox | Sets the data validation for this checkbox item. |
show | Checkbox | Sets whether the item has an "other" option. |
Detailed documentation
clearValidation()
Removes any data validation for this checkbox item.
Return
Checkbox — thisCheckbox, for chaining
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
createChoice(value)
Creates a new choice.
Parameters
| Name | Type | Description |
|---|---|---|
value | String | the choice's value, which respondents see as a label when viewing the form |
Return
Choice — the new choice
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
createChoice(value, isCorrect)
Creates a new choice.
Parameters
| Name | Type | Description |
|---|---|---|
value | String | the choice's value, which respondents see as a label when viewing the form |
is | Boolean | whether the choice is a correct answer |
Return
Choice — the new choice
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
createResponse(responses)
Creates a newItem for this checkbox item. The argumentresponses is aString[] array containing values that need to be checked. Throws an exception if anyvalue does not match a valid choice for this item, unlessshow is set totrue.
Parameters
| Name | Type | Description |
|---|---|---|
responses | String[] | an array of valid answers for this multiple-choice item |
Return
Item — the item response
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
duplicate()
Creates a copy of this item and appends it to the end of the form.
Return
Checkbox — a duplicate of thisCheckbox, for chaining
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
getChoices()
getFeedbackForCorrect()
Returns the feedback that is shown to respondents when they respond correctly to a question.
Return
Quiz — the feedback, if any.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
getFeedbackForIncorrect()
Returns the feedback that is shown to respondents when they respond incorrectly to a question.
Return
Quiz — the feedback, if any.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
getHelpText()
Gets the item's help text (sometimes called description text for layout items likeImage,Page, andSection).
Return
String — the item's help text or description text
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
getId()
Gets the item's unique identifier.
Return
Integer — the item's ID
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
getIndex()
Gets the index of the item among all the items in the form.
Return
Integer — the index of the item
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
getPoints()
Returns the point value of a gradeable item.
Return
Integer — the number of points a question is worth.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
getTitle()
Gets the item's title (sometimes called header text, in the case of aSection).
Return
String — the item's title or header text
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
getType()
hasOtherOption()
Determines whether the item has an "other" option.
Return
Boolean —true if the item has an "other" option;false if not
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
isRequired()
Determines whether the respondent must answer the question.
Return
Boolean — whether the respondent must answer the question
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
setChoiceValues(values)
Sets the choices for an item from an array of strings. Throws an exception if the given arrayis empty.
// Open a form by ID and add a new list item.constform=FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');constitem=form.addListItem();item.setTitle('Do you prefer cats or dogs?');item.setChoiceValues(['Dogs','Cats']);
Parameters
| Name | Type | Description |
|---|---|---|
values | String[] | the array of choice values, which respondents see as labels when viewing the form |
Return
Checkbox — thisCheckbox, for chaining
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
setChoices(choices)
Sets an array of choices for an item. Throws an exception if the given array is empty orcontains anull element.
// Open a form by ID and add a new list item.constform=FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');constitem=form.addListItem();item.setTitle('Do you prefer cats or dogs?');item.setChoices([item.createChoice('Cats'),item.createChoice('Dogs')]);
Parameters
| Name | Type | Description |
|---|---|---|
choices | Choice[] | an array of choices |
Return
Checkbox — thisCheckbox, for chaining
Throws
Error — if the given array isnull, empty, or contains anull element
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
setFeedbackForCorrect(feedback)
Sets the feedback to be shown to respondents when they respond correctly to a question.
// Open a form by ID and add a new list item.constform=FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');constitem=form.addListItem();item.setTitle('Do you prefer cats or dogs?');// Set "Dogs" as the correct answer to this question.item.setChoices([item.createChoice('Dogs',true),item.createChoice('Cats',false),]);// Add feedback which will be shown for correct responses; ie "Dogs".item.setFeedbackForCorrect(FormApp.createFeedback().setDisplayText('Dogs rule, cats drool.').build(),);
Parameters
| Name | Type | Description |
|---|---|---|
feedback | Quiz | the new feedback. A null value will clear the feedback. |
Return
Checkbox — thisCheckbox, for chaining
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
setFeedbackForIncorrect(feedback)
Sets the feedback to be shown to respondents when they respond incorrectly to a question.
Parameters
| Name | Type | Description |
|---|---|---|
feedback | Quiz | the new feedback |
Return
Checkbox — thisCheckbox, for chaining
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
setHelpText(text)
Sets the item's help text (sometimes called description text for layout items likeImage,Page, andSection).
Parameters
| Name | Type | Description |
|---|---|---|
text | String | the new help text |
Return
Checkbox — thisCheckbox, for chaining
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
setPoints(points)
Sets the number of points a gradeable item is worth. The default for new items is 0.
Parameters
| Name | Type | Description |
|---|---|---|
points | Integer | the number of a points a question item is worth |
Return
Checkbox — thisCheckbox, for chaining
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
setRequired(enabled)
Sets whether the respondent must answer the question.
Parameters
| Name | Type | Description |
|---|---|---|
enabled | Boolean | whether the respondent must answer the question |
Return
Checkbox — the current item (for chaining)
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
setTitle(title)
Sets the item's title (sometimes called header text, in the case of aSection).
Parameters
| Name | Type | Description |
|---|---|---|
title | String | the new title or header text |
Return
Checkbox — thisCheckbox, for chaining
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
setValidation(validation)
Sets the data validation for this checkbox item. Passing in null or a validation without anyrequire functions called will remove any prior validation.
Parameters
| Name | Type | Description |
|---|---|---|
validation | Checkbox | a CheckboxValidation to apply to this item. |
Return
Checkbox — thisCheckbox, for chaining
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
showOtherOption(enabled)
Sets whether the item has an "other" option. The default for a newCheckbox orMultiple isfalse.
Parameters
| Name | Type | Description |
|---|---|---|
enabled | Boolean | true if the item has an "other" option;false if not |
Return
Checkbox — thisCheckbox, for chaining
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-11 UTC.