Class PageBreakItem

  • PageBreakItem marks the start of a new page in a form and can be accessed or created from a Form object.

  • You can set the navigation for a page break to jump to another specific page break or use a defined PageNavigationType.

  • Methods likeduplicate(),getHelpText(),getId(),getIndex(),getPageNavigationType(),getTitle(), andgetType() are available for PageBreakItem.

  • Methods likesetGoToPage(),setHelpText(), andsetTitle() allow for modification of PageBreakItem properties.

PageBreakItem

A layout item that marks the start of a page. Items can be accessed or created from aForm.

// Create a form and add three page-break items.constform=FormApp.create('Form Name');constpageTwo=form.addPageBreakItem().setTitle('Page Two');constpageThree=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 threepageThree.setGoToPage(FormApp.PageNavigationType.RESTART);// At end of page two, restart form

Methods

MethodReturn typeBrief description
duplicate()PageBreakItemCreates a copy of this item and appends it to the end of the form.
getGoToPage()PageBreakItemGets thePageBreakItem that the form will jump to after completing the page before thispage break (that is, upon reaching this page break by normal linear progression through theform).
getHelpText()StringGets the item's help text (sometimes called description text for layout items likeImageItems,PageBreakItems, andSectionHeaderItems).
getId()IntegerGets the item's unique identifier.
getIndex()IntegerGets the index of the item among all the items in the form.
getPageNavigationType()PageNavigationTypeGets the type of page navigation that occurs after completing the page before this page break(that is, upon reaching this page break by normal linear progression through the form).
getTitle()StringGets the item's title (sometimes called header text, in the case of aSectionHeaderItem).
getType()ItemTypeGets the item's type, represented as anItemType.
setGoToPage(goToPageItem)PageBreakItemSets the page to jump to after completing the page before this page break (that is, uponreaching this page break by normal linear progression through the form).
setGoToPage(navigationType)PageBreakItemSets the type of page navigation that occurs after completing the page before this page break(that is, upon reaching this page break by normal linear progression through the form).
setHelpText(text)PageBreakItemSets the item's help text (sometimes called description text for layout items likeImageItems,PageBreakItems, andSectionHeaderItems).
setTitle(title)PageBreakItemSets the item's title (sometimes called header text, in the case of aSectionHeaderItem).

Detailed documentation

duplicate()

Creates a copy of this item and appends it to the end of the form.

Return

PageBreakItem — a duplicate of thisPageBreakItem, for chaining

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

getGoToPage()

Gets thePageBreakItem that the form will jump to after completing the page before thispage break (that is, upon reaching this page break by normal linear progression through theform).

Return

PageBreakItem — the page break to jump to after completing the page before this page break, ornull if none is set

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

getHelpText()

Gets the item's help text (sometimes called description text for layout items likeImageItems,PageBreakItems, andSectionHeaderItems).

Return

String — the item's help text or description text

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

getId()

Gets the item's unique identifier.

Return

Integer — the item's ID

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

getIndex()

Gets the index of the item among all the items in the form.

Return

Integer — the index of the item

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

getPageNavigationType()

Gets the type of page navigation that occurs after completing the page before this page break(that is, upon reaching this page break by normal linear progression through the form).

Return

PageNavigationType — the navigation action to take after completing the page before this page break

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

getTitle()

Gets the item's title (sometimes called header text, in the case of aSectionHeaderItem).

Return

String — the item's title or header text

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

getType()

Gets the item's type, represented as anItemType.

Return

ItemType — the item's type

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

setGoToPage(goToPageItem)

Sets the page to jump to after completing the page before this page break (that is, uponreaching this page break by normal linear progression through the form). If the previous pagecontained aMultipleChoiceItem orListItem with a navigation option, thatnavigation overrules this navigation.

Parameters

NameTypeDescription
goToPageItemPageBreakItemthe page break to jump to after completing the page before this page break

Return

PageBreakItem — thisPageBreakItem, for chaining

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

setGoToPage(navigationType)

Sets the type of page navigation that occurs after completing the page before this page break(that is, upon reaching this page break by normal linear progression through the form). If thepage contained aMultipleChoiceItem orListItem with a navigation option, thatnavigation overrules this navigation.

Parameters

NameTypeDescription
navigationTypePageNavigationTypethe navigation action to take after completing the page before this page break

Return

PageBreakItem — thisPageBreakItem, for chaining

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

setHelpText(text)

Sets the item's help text (sometimes called description text for layout items likeImageItems,PageBreakItems, andSectionHeaderItems).

Parameters

NameTypeDescription
textStringthe new help text

Return

PageBreakItem — thisPageBreakItem, for chaining

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

setTitle(title)

Sets the item's title (sometimes called header text, in the case of aSectionHeaderItem).

Parameters

NameTypeDescription
titleStringthe new title or header text

Return

PageBreakItem — thisPageBreakItem, for chaining

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

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

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-11 UTC.