Class CheckboxItem

A question item that allows the respondent to select one or more checkboxes, as well as an optional "other" field. Items can be accessed or created from a Form.

 // Open a form by ID and add a new checkbox item.
 var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
 var item = 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
`createChoice(value)`	`Choice`	Creates a new choice.
`createResponse(responses)`	`ItemResponse`	Creates a new `ItemResponse` for this checkbox item.
`duplicate()`	`CheckboxItem`	Creates a copy of this item and appends it to the end of the form.
`getChoices()`	`Choice[]`	Gets all choices for an item.
`getHelpText()`	`String`	Gets the item's help text (sometimes called description text for layout items like `ImageItems`, `PageBreakItems`, and `SectionHeaderItems`).
`getId()`	`Integer`	Gets the item's unique identifier.
`getIndex()`	`Integer`	Gets the index of the item among all the items in the form.
`getTitle()`	`String`	Gets the item's title (sometimes called header text, in the case of a `SectionHeaderItem`).
`getType()`	`ItemType`	Gets the item's type, represented as an `ItemType`.
`hasOtherOption()`	`Boolean`	Determines whether the item has an "other" option.
`isRequired()`	`Boolean`	Determines whether the respondent must answer the question.
`setChoiceValues(values)`	`CheckboxItem`	Sets the choices for an item from an array of strings.
`setChoices(choices)`	`CheckboxItem`	Sets an array of choices for an item.
`setHelpText(text)`	`CheckboxItem`	Sets the item's help text (sometimes called description text for layout items like `ImageItems`, `PageBreakItems`, and `SectionHeaderItems`).
`setRequired(enabled)`	`CheckboxItem`	Sets whether the respondent must answer the question.
`setTitle(title)`	`CheckboxItem`	Sets the item's title (sometimes called header text, in the case of a `SectionHeaderItem`).
`showOtherOption(enabled)`	`CheckboxItem`	Sets whether the item has an "other" option.

Detailed documentation

`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

`createResponse(responses)`

Creates a new ItemResponse for this checkbox item. The argument responses is a String[] array containing values that need to be checked. Throws an exception if any value does not match a valid choice for this item, unless showOtherOption(enabled) is set to true.

Parameters

Name	Type	Description
`responses`	`String[]`	an array of valid answers for this multiple-choice item

Return

ItemResponse — the item response

`duplicate()`

Creates a copy of this item and appends it to the end of the form.

Return

CheckboxItem — a duplicate of this CheckboxItem, for chaining

`getChoices()`

Gets all choices for an item.

Return

Choice[] — an array of choices

`getHelpText()`

Gets the item's help text (sometimes called description text for layout items like ImageItems, PageBreakItems, and SectionHeaderItems).

Return

String — the item's help text or description text

`getId()`

Gets the item's unique identifier.

Return

Integer — the item's ID

`getIndex()`

Gets the index of the item among all the items in the form.

Return

Integer — the index of the item

`getTitle()`

Gets the item's title (sometimes called header text, in the case of a SectionHeaderItem).

Return

String — the item's title or header text

`getType()`

Gets the item's type, represented as an ItemType.

Return

ItemType — the item's type

`hasOtherOption()`

Determines whether the item has an "other" option.

Return

Boolean — true if the item has an "other" option; false if not

`isRequired()`

Determines whether the respondent must answer the question.

Return

Boolean — whether the respondent must answer the question

`setChoiceValues(values)`

Sets the choices for an item from an array of strings. Throws an exception if the given array is empty.

 // Open a form by ID and add a new list item.
 var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
 var item = 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

CheckboxItem — this CheckboxItem, for chaining

`setChoices(choices)`

Sets an array of choices for an item. Throws an exception if the given array is empty or contains a null element.

 // Open a form by ID and add a new list item.
 var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
 var item = 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

CheckboxItem — this CheckboxItem, for chaining

`setHelpText(text)`

Sets the item's help text (sometimes called description text for layout items like ImageItems, PageBreakItems, and SectionHeaderItems).

Parameters

Name	Type	Description
`text`	`String`	the new help text

Return

CheckboxItem — this CheckboxItem, for chaining

`setRequired(enabled)`

Sets whether the respondent must answer the question.

Parameters

Name	Type	Description
`enabled`	`Boolean`	whether the respondent must answer the question

Return

CheckboxItem — the current item (for chaining)

`setTitle(title)`

Sets the item's title (sometimes called header text, in the case of a SectionHeaderItem).

Parameters

Name	Type	Description
`title`	`String`	the new title or header text

Return

CheckboxItem — this CheckboxItem, for chaining

`showOtherOption(enabled)`

Sets whether the item has an "other" option. The default for a new CheckboxItem or MultipleChoiceItem is false.

Parameters

Name	Type	Description
`enabled`	`Boolean`	`true` if the item has an "other" option; `false` if not

Return

CheckboxItem — this CheckboxItem, for chaining

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License, and code samples are licensed under the Apache 2.0 License. For details, see our Site Policies.

Last updated February 26, 2015.