Interface Item

单品

通用表单项，包含所有项共有的属性，例如标题和帮助文本。 可以通过 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()CheckboxGridItem将该项作为复选框网格项返回。
asCheckboxItem()CheckboxItem将该项作为复选框项返回。
asDateItem()DateItem将内容作为日期项返回。
asDateTimeItem()DateTimeItem将内容作为日期时间项返回。
asDurationItem()DurationItem将相应内容作为时长项返回。
asGridItem()GridItem以网格项的形式返回该项。
asImageItem()ImageItem将内容作为图片项返回。
asListItem()ListItem将该项作为列表项返回。
asMultipleChoiceItem()MultipleChoiceItem将该项作为单选题返回。
asPageBreakItem()PageBreakItem将该项作为分页符项返回。
asParagraphTextItem()ParagraphTextItem将内容作为段落文本项返回。
asScaleItem()ScaleItem将内容作为缩放项返回。
asSectionHeaderItem()SectionHeaderItem将该项作为版块标题项返回。
asTextItem()TextItem将内容作为文本项返回。
asTimeItem()TimeItem将内容作为时间项返回。
asVideoItem()VideoItem将该项作为视频项返回。
duplicate()Item创建此项的副本，并将其附加到表单末尾。
getHelpText()String获取相应项的帮助文本（对于 ImageItems、PageBreakItems 和 SectionHeaderItems 等布局项，有时称为说明文本）。
getId()Integer获取商品的唯一标识符。
getIndex()Integer获取相应项在表单中所有项中的索引。
getTitle()String获取相应项的标题（如果是 SectionHeaderItem，则有时称为标题文本）。
getType()ItemType获取项目的类型，表示为 ItemType。
setHelpText(text)Item设置项的帮助文本（有时为 ImageItems、PageBreakItems 和 SectionHeaderItems 等布局项的说明文本）。
setTitle(title)Item设置项的标题（对于 SectionHeaderItem，有时称为标题文本）。

详细文档

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()

将内容作为日期项返回。如果 ItemType 尚未为 DATE，则会抛出脚本异常。

返回

DateItem - 日期项

抛出

Error - 如果内容并非日期项

授权

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

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

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()

以网格项的形式返回该项。如果 ItemType 尚未为 GRID，则会抛出脚本异常。

返回

GridItem - 网格项

抛出

Error - 如果项不是网格项

授权

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

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

asImageItem()

将内容作为图片项返回。如果 ItemType 尚未为 IMAGE，则会抛出脚本异常。

返回

ImageItem - 图片项

抛出

Error - 如果项不是图片项

asListItem()

将该项作为列表项返回。如果 ItemType 尚未为 LIST，则会抛出脚本异常。

返回

ListItem - 列表项

抛出

Error - 如果项不是列表项

授权

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

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

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()

将内容作为缩放项返回。如果 ItemType 尚未为 SCALE，则会抛出脚本异常。

返回

ScaleItem - 缩放项

抛出

Error - 如果该项不是比例项

授权

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

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

asSectionHeaderItem()

将该项作为版块标题项返回。如果 ItemType 尚未为 SECTION_HEADER，则会抛出脚本异常。

返回

SectionHeaderItem - 小节标题项

抛出

Error - 如果该项不是章节标题项

授权

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

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

asTextItem()

将内容作为文本项返回。如果 ItemType 尚未为 TEXT，则会抛出脚本异常。

返回

TextItem - 文本项

抛出

Error - 如果项不是文本项

授权

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

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

asTimeItem()

将内容作为时间项返回。如果 ItemType 尚未为 TIME，则会抛出脚本异常。

返回

TimeItem - 时间项

抛出

Error - 如果内容不是时间项

授权

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

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

asVideoItem()

将该项作为视频项返回。如果 ItemType 尚未为 VIDEO，则会抛出脚本异常。

返回

VideoItem - 视频项

抛出

Error - 如果项不是视频项

duplicate()

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

返回

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

授权

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

  • 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

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

setHelpText(text)

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

参数

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

返回

Item - 此 Item，用于链接

授权

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

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

setTitle(title)

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

参数

名称类型说明
titleString新的标题文字

返回

Item - 此 Item，用于链接

授权

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

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