Class PageBreakItem

页面分隔符项

用于标记页面开头的布局项。您可以通过 Form 访问或创建项。 

// Create a form and add three page-break items.
const form = FormApp.create('Form Name');
const pageTwo = form.addPageBreakItem().setTitle('Page Two');
const pageThree = form.addPageBreakItem().setTitle('Page Three');

// Make the first two pages navigate elsewhere upon completion.
pageTwo.setGoToPage(
    pageThree);  // At end of page one (start of page two), jump to page three
pageThree.setGoToPage(
    FormApp.PageNavigationType.RESTART);  // At end of page two, restart form

方法

方法返回类型简介
duplicate()PageBreakItem创建此项的副本，并将其附加到表单的末尾。
getGoToPage()PageBreakItem获取表单在完成此分页之前的页面后跳转到的 PageBreakItem（即，通过正常的线性方式逐页浏览表单后到达此分页时）。
getHelpText()String获取项的帮助文本（对于 ImageItems、PageBreakItems 和 SectionHeaderItems 等布局项，有时也称为说明文本）。
getId()Integer获取内容的唯一标识符。
getIndex()Integer获取表单中所有项中的项的索引。
getPageNavigationType()PageNavigationType获取在完成此分页之前的页面后（即通过正常的线性方式逐一填写表单后到达此分页）发生的页面导航类型。
getTitle()String获取项的标题（对于 SectionHeaderItem，有时称为标题文本）。
getType()ItemType获取项的类型，表示为 ItemType。
setGoToPage(goToPageItem)PageBreakItem设置在完成此分页符之前的页面后跳转到的页面（即，通过正常的线性方式逐页填写表单后到达此分页符时）。
setGoToPage(navigationType)PageBreakItem设置在完成此分页之前的页面后（即通过正常的线性方式逐一填写表单后到达此分页）发生的页面导航类型。
setHelpText(text)PageBreakItem设置项的帮助文本（对于布局项，有时称为说明文本，例如 ImageItems、PageBreakItems 和 SectionHeaderItems）。
setTitle(title)PageBreakItem设置项的标题（对于 SectionHeaderItem，有时称为标题文本）。

详细文档

duplicate()

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

返回

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

授权

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

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

getGoToPage()

获取表单在完成此分页之前的页面后跳转到的 PageBreakItem（即，通过正常的线性方式逐页浏览表单后到达此分页时）。

返回

PageBreakItem - 在完成此分页符之前的页面后跳转到的分页符，如果未设置任何分页符，则为 null

授权

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

  • 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

getPageNavigationType()

获取在完成此分页之前的页面后（即通过正常的线性方式逐一填写表单后到达此分页）发生的页面导航类型。

返回

PageNavigationType - 在完成此分页符之前的页面后执行的导航操作

授权

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

  • 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

setGoToPage(goToPageItem)

设置在完成此分页符之前的页面后跳转到的页面（即，通过正常的线性方式逐一填写表单后到达此分页符时）。如果上一页包含包含导航选项的 MultipleChoiceItem 或 ListItem，则该导航会覆盖此导航。

参数

名称类型说明
goToPageItemPageBreakItem在完成此分页符前面的页面后跳转到的分页符

返回

PageBreakItem - 此 PageBreakItem，用于链式调用

授权

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

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

setGoToPage(navigationType)

设置在完成此分页之前的页面后（即通过正常的线性进度浏览表单后到达此分页）发生的页面导航类型。如果页面包含带有导航选项的 MultipleChoiceItem 或 ListItem，则该导航会覆盖此导航。

参数

名称类型说明
navigationTypePageNavigationType在本页面中断之前完成此页面后要执行的导航操作

返回

PageBreakItem - 此 PageBreakItem，用于链式调用

授权

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

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

setHelpText(text)

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

参数

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

返回

PageBreakItem - 此 PageBreakItem，用于链式调用

授权

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

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

setTitle(title)

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

参数

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

返回

PageBreakItem - 此 PageBreakItem，用于链式调用

授权

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

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