Class PageBreakItem

PageBreakItem

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

// Create a form and add three page-break items.
var form = FormApp.create('Form Name');
var pageTwo = form.addPageBreakItem().setTitle('Page Two');
var 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获取相应项的帮助文本(对于 ImageItemsPageBreakItemsSectionHeaderItems 等布局项,有时称为说明文本)。
getId()Integer获取商品的唯一标识符。
getIndex()Integer获取相应项在表单中所有项中的索引。
getPageNavigationType()PageNavigationType获取在分页符之前完成页面后发生的页面导航类型 (即,在通过表单正常线性顺序到达此分页符时)。
getTitle()String获取相应项的标题(如果是 SectionHeaderItem,则有时称为标题文本)。
getType()ItemType获取项目的类型,表示为 ItemType
setGoToPage(goToPageItem)PageBreakItem将页面设置为在分页符之前(即 按正常的线性顺序到达此分页符时)。
setGoToPage(navigationType)PageBreakItem设置在分页符之前完成页面后发生的页面导航类型 (即,在通过表单正常线性顺序到达此分页符时)。
setHelpText(text)PageBreakItem设置项的帮助文本(有时为 ImageItemsPageBreakItemsSectionHeaderItems 等布局项的说明文本)。
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()

获取相应项的帮助文本(对于 ImageItemsPageBreakItemsSectionHeaderItems 等布局项,有时称为说明文本)。

返回

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)

将页面设置为在分页符之前(即 按正常的线性顺序到达此分页符时)。如果返回上一页 包含带有导航选项的 MultipleChoiceItemListItem, 导航优先于此导航。

参数

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

返回

PageBreakItem - 此 PageBreakItem,用于链接

授权

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

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

setGoToPage(navigationType)

设置在分页符之前完成页面后发生的页面导航类型 (即,在通过表单正常线性顺序到达此分页符时)。如果 页面包含一个带有导航选项的 MultipleChoiceItemListItem, 导航优先于此导航。

参数

名称类型说明
navigationTypePageNavigationType在此页面之前浏览完页面后执行的导航操作 休息时间

返回

PageBreakItem - 此 PageBreakItem,用于链接

授权

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

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

setHelpText(text)

设置项的帮助文本(有时为 ImageItemsPageBreakItemsSectionHeaderItems 等布局项的说明文本)。

参数

名称类型说明
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