此页面由 Cloud Translation API 翻译。

Class CheckboxItem

可让回复者选择一个或多个复选框以及可选的“其他”字段。可以通过 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);

方法

方法	返回类型	简介
`clearValidation()`	`CheckboxItem`	删除此复选框项的所有数据验证。
`createChoice(value)`	`Choice`	创建新选项。
`createChoice(value, isCorrect)`	`Choice`	创建新选项。
`createResponse(responses)`	`ItemResponse`	为该复选框项创建一个新的 `ItemResponse`。
`duplicate()`	`CheckboxItem`	创建此项的副本，并将其附加到表单末尾。
`getChoices()`	`Choice[]`	获取项的所有选项。
`getFeedbackForCorrect()`	`QuizFeedback`	返回回复者在正确回答问题后向其显示的反馈。
`getFeedbackForIncorrect()`	`QuizFeedback`	返回回复者在对问题回答错误时向其显示的反馈。
`getHelpText()`	`String`	获取相应项的帮助文本（对于 `ImageItems`、`PageBreakItems` 和 `SectionHeaderItems` 等布局项，有时称为说明文本）。
`getId()`	`Integer`	获取商品的唯一标识符。
`getIndex()`	`Integer`	获取相应项在表单中所有项中的索引。
`getPoints()`	`Integer`	返回可评分的内容的分值。
`getTitle()`	`String`	获取相应项的标题（如果是 `SectionHeaderItem`，则有时称为标题文本）。
`getType()`	`ItemType`	获取项目的类型，表示为 `ItemType`。
`hasOtherOption()`	`Boolean`	确定项是否有“其他”选项。
`isRequired()`	`Boolean`	确定受访者是否必须回答问题。
`setChoiceValues(values)`	`CheckboxItem`	从字符串数组中设置项的选项。
`setChoices(choices)`	`CheckboxItem`	为项设置选项数组。
`setFeedbackForCorrect(feedback)`	`CheckboxItem`	设置在受访者正确回答问题时向其显示的反馈。
`setFeedbackForIncorrect(feedback)`	`CheckboxItem`	设置在回复者对问题回答错误时向其显示的反馈。
`setHelpText(text)`	`CheckboxItem`	设置项的帮助文本（有时为 `ImageItems`、`PageBreakItems` 和 `SectionHeaderItems` 等布局项的说明文本）。
`setPoints(points)`	`CheckboxItem`	设置可评分项的分值。
`setRequired(enabled)`	`CheckboxItem`	设置受访者是否必须回答问题。
`setTitle(title)`	`CheckboxItem`	设置项的标题（对于 `SectionHeaderItem`，有时称为标题文本）。
`setValidation(validation)`	`CheckboxItem`	设置此复选框项的数据验证。
`showOtherOption(enabled)`	`CheckboxItem`	设置项是否有“其他”选项。

详细文档

`clearValidation()`

删除此复选框项的所有数据验证。

CheckboxItem - 此 CheckboxItem，用于链接

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`createChoice(value)`

创建新选项。

参数

名称	类型	说明
`value`	`String`	选项的值，受访者在查看表单时将其视为标签

Choice - 新选择

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`createChoice(value, isCorrect)`

创建新选项。

参数

名称	类型	说明
`value`	`String`	选项的值，受访者在查看表单时将其视为标签
`isCorrect`	`Boolean`	该选择是否正确

Choice - 新选择

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`createResponse(responses)`

为该复选框项创建一个新的 ItemResponse。参数 responses 是 String[] 数组，其中包含需要检查的值。抛出异常（如果有）值与此内容的有效选择不匹配，除非 showOtherOption(enabled) 设置为 true。

参数

名称	类型	说明
`responses`	`String[]`	此单选题的一组有效答案

ItemResponse - 商品响应

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`duplicate()`

创建此项的副本，并将其附加到表单末尾。

CheckboxItem - 此 CheckboxItem 的副本，用于链接

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`getChoices()`

获取项的所有选项。

Choice[] - 选项数组

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`getFeedbackForCorrect()`

返回回复者在正确回答问题后向其显示的反馈。

QuizFeedback - 反馈（如果有）。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`getFeedbackForIncorrect()`

返回回复者在对问题做出错误回答时向其显示的反馈。

QuizFeedback - 反馈（如果有）。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`getHelpText()`

获取相应项的帮助文本（对于 ImageItems、PageBreakItems 和 SectionHeaderItems 等布局项，有时称为说明文本）。

String - 项目的帮助文本或说明文本

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`getId()`

获取商品的唯一标识符。

Integer - 商品的 ID

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`getIndex()`

获取相应项在表单中所有项中的索引。

Integer - 项的索引

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`getPoints()`

返回可评分的内容的分值。

Integer - 问题的价值分数。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`getTitle()`

获取相应项的标题（如果是 SectionHeaderItem，则有时称为标题文本）。

String - 商品的标题或标题文本

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`getType()`

获取项目的类型，表示为 ItemType。

ItemType - 项的类型

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`hasOtherOption()`

确定项是否有“其他”选项。

Boolean - true（如果内容包含“其他”）选项；如果不是，则为 false

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`isRequired()`

确定受访者是否必须回答问题。

Boolean - 受访者是否必须回答问题

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`setChoiceValues(values)`

从字符串数组中设置项的选项。如果给定数组，则会抛出异常为空。

// 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']);

参数

名称	类型	说明
`values`	`String[]`	选项值的数组，受访者在查看表单时将其视为标签

CheckboxItem - 此 CheckboxItem，用于链接

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`setChoices(choices)`

为项设置选项数组。如果给定数组为空或包含 null 元素。

// 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')
]);

参数

名称	类型	说明
`choices`	`Choice[]`	选项数组

CheckboxItem - 此 CheckboxItem，用于链接

抛出

Error - 如果给定数组为 null、空或包含 null 元素

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`setFeedbackForCorrect(feedback)`

设置在受访者正确回答问题时向其显示的反馈。

// 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?');
// 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());

参数

名称	类型	说明
`feedback`	`QuizFeedback`	新反馈。null 值将清除反馈。

CheckboxItem - 此 CheckboxItem，用于链接

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`setFeedbackForIncorrect(feedback)`

设置在回复者对问题回答错误时向其显示的反馈。

参数

名称	类型	说明
`feedback`	`QuizFeedback`	新反馈

CheckboxItem - 此 CheckboxItem，用于链接

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`setHelpText(text)`

设置项的帮助文本（有时为 ImageItems、PageBreakItems 和 SectionHeaderItems 等布局项的说明文本）。

参数

名称	类型	说明
`text`	`String`	新的帮助文本

CheckboxItem - 此 CheckboxItem，用于链接

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`setPoints(points)`

设置可评分项的分值。新项的默认值为 0。

参数

名称	类型	说明
`points`	`Integer`	问题项的分值

CheckboxItem - 此 CheckboxItem，用于链接

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`setRequired(enabled)`

设置受访者是否必须回答问题。

参数

名称	类型	说明
`enabled`	`Boolean`	受访者是否必须回答问题

CheckboxItem - 当前项（用于链式）

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`setTitle(title)`

设置项的标题（对于 SectionHeaderItem，有时称为标题文本）。

参数

名称	类型	说明
`title`	`String`	新的标题文字

CheckboxItem - 此 CheckboxItem，用于链接

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`setValidation(validation)`

设置此复选框项的数据验证。传入 null 或没有任何验证需要调用的函数将删除所有先前的验证。

参数

名称	类型	说明
`validation`	`CheckboxValidation`	要应用于此项目的 CheckboxValidation。

CheckboxItem - 此 CheckboxItem，用于链接

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`showOtherOption(enabled)`

设置项是否有“其他”选项。新 CheckboxItem 的默认值，或 “MultipleChoiceItem”为“false”。

参数

名称	类型	说明
`enabled`	`Boolean`	如果项的值为“other”，则值为 `true`选项；如果不是，则为 `false`

CheckboxItem - 此 CheckboxItem，用于链接

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms