一个通用表单项,包含所有内容通用的属性,例如标题和帮助文本。
您可以通过 Form
访问或创建项。
如需对类型特有属性执行操作,请使用 getType()
检查相应内容的 ItemType
,然后使用 asCheckboxItem()
等方法将相应内容投射到相应的类。
// Create a new form and add a text item. var form = FormApp.create('Form Name'); form.addTextItem(); // Access the text item as a generic item. var items = form.getItems(); var item = items[0]; // Cast the generic item to the text-item class. if (item.getType() == 'TEXT') { var textItem = item.asTextItem(); textItem.setRequired(false); }
实现类
名称 | 简介 |
---|
方法
详细文档
asCheckboxGridItem()
将项目作为复选框网格项返回。如果 ItemType
尚未为 CHECKBOX_GRID
,则会抛出一个脚本异常。
返回
CheckboxGridItem
- 复选框网格项
抛出
Error
- 如果内容不是复选框网格项
授权
使用此方法的脚本需要通过以下一个或多个范围进行授权:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
asCheckboxItem()
以复选框项目的形式返回项目。如果 ItemType
尚未为 CHECKBOX
,则会抛出一个脚本异常。
返回
CheckboxItem
- 复选框项
抛出
Error
- 如果该项不是复选框项
授权
使用此方法的脚本需要通过以下一个或多个范围进行授权:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
asDateItem()
asDateTimeItem()
返回日期时间项。如果 ItemType
尚未为 DATETIME
,则会抛出一个脚本异常。
返回
DateTimeItem
- 日期时间项目
抛出
Error
- 如果该项不是日期时间项
授权
使用此方法的脚本需要通过以下一个或多个范围进行授权:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
asDurationItem()
以时长项目形式返回项目。如果 ItemType
尚未为 DURATION
,则会抛出一个脚本异常。
返回
DurationItem
- 时长项目
抛出
Error
- 如果该项不是时长项
授权
使用此方法的脚本需要通过以下一个或多个范围进行授权:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
asGridItem()
asListItem()
asMultipleChoiceItem()
以多选选项形式返回项目。如果 ItemType
尚未为 MULTIPLE_CHOICE
,则会抛出一个脚本异常。
返回
MultipleChoiceItem
- 多选项目
抛出
Error
- 如果内容不是单选题
授权
使用此方法的脚本需要通过以下一个或多个范围进行授权:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
asPageBreakItem()
以分页项形式返回项。如果 ItemType
尚未为 PAGE_BREAK
,则会抛出一个脚本异常。
返回
PageBreakItem
- 分页项
抛出
Error
- 如果该项不是分页项
授权
使用此方法的脚本需要通过以下一个或多个范围进行授权:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
asParagraphTextItem()
以段落文本形式返回内容。如果 ItemType
尚未为 PARAGRAPH_TEXT
,则会抛出一个脚本异常。
返回
ParagraphTextItem
- 段落文本项
抛出
Error
- 如果内容不是段落文本项
授权
使用此方法的脚本需要通过以下一个或多个范围进行授权:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
asScaleItem()
asSectionHeaderItem()
以版块标题项的形式返回项。如果 ItemType
尚未为 SECTION_HEADER
,则会抛出一个脚本异常。
返回
SectionHeaderItem
- 版块标题项
抛出
Error
- 如果内容不是某个部分的标题项
授权
使用此方法的脚本需要通过以下一个或多个范围进行授权:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
asTextItem()
asTimeItem()
duplicate()
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
getTitle()
获取项的标题(有时称为标题文本,适用于 SectionHeaderItem
)。
返回
String
- 商品的标题或标题文字
授权
使用此方法的脚本需要通过以下一个或多个范围进行授权:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
getType()
setHelpText(text)
设置项的帮助文本(有时称为 ImageItems
、PageBreakItems
和 SectionHeaderItems
等布局项的说明文本)。
参数
名称 | 类型 | 说明 |
---|---|---|
text | String | 新的帮助文本 |
返回
授权
使用此方法的脚本需要通过以下一个或多个范围进行授权:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
setTitle(title)
设置项的标题(有时称为标题文本,适用于 SectionHeaderItem
)。
参数
名称 | 类型 | 说明 |
---|---|---|
title | String | 新的标题或标题文字 |
返回
授权
使用此方法的脚本需要通过以下一个或多个范围进行授权:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms