Class PageBreakItem

PageBreakItem

A layout item that marks the start of a page. Items can be accessed or created from a 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
 

Methods

MethodReturn typeBrief description
duplicate()PageBreakItemCreates a copy of this item and appends it to the end of the form.
getGoToPage()PageBreakItemGets the PageBreakItem that the form will jump to after completing the page before this page break (that is, upon reaching this page break by normal linear progression through the form).
getHelpText()StringGets the item's help text (sometimes called description text for layout items like ImageItems, PageBreakItems, and SectionHeaderItems).
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 a SectionHeaderItem).
getType()ItemTypeGets the item's type, represented as an ItemType.
setGoToPage(goToPageItem)PageBreakItemSets the page to jump to after completing the page before this page break (that is, upon reaching 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 like ImageItems, PageBreakItems, and SectionHeaderItems).
setTitle(title)PageBreakItemSets the item's title (sometimes called header text, in the case of a SectionHeaderItem).

Detailed documentation

duplicate()

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

Return

PageBreakItem — a duplicate of this PageBreakItem, for chaining


getGoToPage()

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

Return

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


getHelpText()

Gets the item's help text (sometimes called description text for layout items like ImageItems, PageBreakItems, and SectionHeaderItems).

Return

String — the item's help text or description text


getId()

Gets the item's unique identifier.

Return

Integer — the item's ID


getIndex()

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

Return

Integer — the index of the item


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


getTitle()

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

Return

String — the item's title or header text


getType()

Gets the item's type, represented as an ItemType.

Return

ItemType — the item's type


setGoToPage(goToPageItem)

Sets the page to jump to after completing the page before this page break (that is, upon reaching this page break by normal linear progression through the form). If the previous page contained a MultipleChoiceItem or ListItem with a navigation option, that navigation overrules this navigation.

Parameters

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

Return

PageBreakItem — this PageBreakItem, for chaining


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 the page contained a MultipleChoiceItem or ListItem with a navigation option, that navigation overrules this navigation.

Parameters

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

Return

PageBreakItem — this PageBreakItem, for chaining


setHelpText(text)

Sets the item's help text (sometimes called description text for layout items like ImageItems, PageBreakItems, and SectionHeaderItems).

Parameters

NameTypeDescription
textStringthe new help text

Return

PageBreakItem — this PageBreakItem, for chaining


setTitle(title)

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

Parameters

NameTypeDescription
titleStringthe new title or header text

Return

PageBreakItem — this PageBreakItem, for chaining

发送以下问题的反馈:

此网页
Apps Script
Apps Script