Class CheckboxGridItem

复选框网格项

一种题目项，以列和行的网格形式呈现，可让回复者从一系列复选框中为每行选择多个选项。您可以通过 Form 访问或创建项。

// Open a form by ID and add a new checkbox grid item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addCheckboxGridItem();
item.setTitle('Where did you celebrate New Years?')
    .setRows(['New York', 'San Francisco', 'London'])
    .setColumns(['2014', '2015', '2016', '2017']);

方法

方法	返回类型	简介
clearValidation()	CheckboxGridItem	移除此网格项的所有数据验证。
createResponse(responses)	ItemResponse	为此复选框网格项创建新的 ItemResponse。
duplicate()	CheckboxGridItem	创建此项的副本，并将其附加到表单的末尾。
getColumns()	String[]	获取网格中每列的值。
getHelpText()	String	获取项的帮助文本（对于 ImageItems、PageBreakItems 和 SectionHeaderItems 等布局项，有时也称为说明文本）。
getId()	Integer	获取内容的唯一标识符。
getIndex()	Integer	获取表单中所有项中的项的索引。
getRows()	String[]	获取网格中每行的值。
getTitle()	String	获取项的标题（对于 SectionHeaderItem，有时称为标题文本）。
getType()	ItemType	获取项的类型，表示为 ItemType。
isRequired()	Boolean	确定回复者是否必须回答该问题。
setColumns(columns)	CheckboxGridItem	根据值数组设置网格的列。
setHelpText(text)	CheckboxGridItem	设置项的帮助文本（对于布局项，有时也称为说明文本，例如 ImageItems、PageBreakItems 和 SectionHeaderItems）。
setRequired(enabled)	CheckboxGridItem	设置回复者是否必须回答该问题。
setRows(rows)	CheckboxGridItem	根据值数组设置网格的行。
setTitle(title)	CheckboxGridItem	设置项的标题（对于 SectionHeaderItem，有时称为标题文本）。
setValidation(validation)	CheckboxGridItem	设置此复选框网格项的数据验证。

详细文档

clearValidation()

移除此网格项的所有数据验证。

返回

CheckboxGridItem - 此项，用于链式调用

授权

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

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

---

createResponse(responses)

为此复选框网格项创建新的 ItemResponse。参数 responses 必须是 String[][] 数组数组，其中包含的值数量与复选框网格中的输入数量相同。非必填多选网格问题的 null 元素表示没有对该行的回复。如果任何值与有效选项不匹配，则会抛出异常。

参数

名称	类型	说明
responses	String[][]	此复选框网格项的有效答案的数组数组

返回

ItemResponse - 内容响应

授权

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

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

---

duplicate()

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

返回

CheckboxGridItem - 此 CheckboxGridItem 的副本，用于链式调用

授权

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

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

---

getColumns()

获取网格中每列的值。

返回

String[] - 列值数组，受访者在查看表单时会将其视为标签

授权

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

• 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

---

getRows()

获取网格中每行的值。

返回

String[] - 行值数组，受访者在查看表单时会将其视为标签

授权

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

• 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

---

isRequired()

确定回复者是否必须回答该问题。

返回

Boolean - 回复者是否必须回答此问题

授权

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

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

---

setColumns(columns)

根据值数组设置网格的列。如果给定数组为空，则会抛出异常。

参数

名称	类型	说明
columns	String[]	列值数组，受访者在查看表单时会将其视为标签

返回

CheckboxGridItem - 此项，用于链式调用

抛出

Error - 如果给定数组为 null 或为空

授权

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

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

---

setHelpText(text)

设置项的帮助文本（对于布局项，有时也称为说明文本，例如 ImageItems、PageBreakItems 和 SectionHeaderItems）。

参数

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

返回

CheckboxGridItem - 此 CheckboxGridItem，用于链式调用

授权

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

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

---

setRequired(enabled)

设置回复者是否必须回答该问题。

参数

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

返回

CheckboxGridItem - 当前项（用于链接）

授权

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

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

---

setRows(rows)

根据值数组设置网格的行。如果给定数组为空，则会抛出异常。

参数

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

返回

CheckboxGridItem - 此项，用于链式调用

抛出

Error - 如果给定数组为 null 或为空

授权

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

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

---

setTitle(title)

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

参数

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

返回

CheckboxGridItem - 此 CheckboxGridItem，用于链式调用

授权

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

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

---

setValidation(validation)

设置此复选框网格项的数据验证。如果传入 null 或未调用任何 require 函数的验证，则会移除所有之前的验证。

参数

名称	类型	说明
validation	CheckboxGridValidation	要应用于此项的 CheckboxGridValidation。

返回

CheckboxGridItem - 此 CheckboxGridItem，用于链式调用

授权

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

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