Class CheckboxGridItem

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