Class PageBreakItem

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