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 Получает текст справки по элементу (иногда называемый текстом описания для таких элементов макета, как 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 — идентификатор предмета

Авторизация

Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • 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 с параметром навигации, эта навигация отменяет эту навигацию.

Параметры

Имя Тип Описание
goToPageItem PageBreakItem разрыв страницы, к которому можно перейти после завершения страницы до этого разрыва страницы

Возвращаться

PageBreakItem — этот PageBreakItem для цепочки

Авторизация

Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

setGoToPage(navigationType)

Устанавливает тип навигации по странице, который происходит после завершения страницы до этого разрыва страницы (то есть при достижении этого разрыва страницы путем обычного линейного продвижения по форме). Если страница содержала MultipleChoiceItem или ListItem с параметром навигации, эта навигация отменяет эту навигацию.

Параметры

Имя Тип Описание
navigationType PageNavigationType действие навигации, которое необходимо предпринять после завершения страницы до разрыва страницы

Возвращаться

PageBreakItem — этот PageBreakItem для цепочки

Авторизация

Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

setHelpText(text)

Устанавливает текст справки для элемента (иногда называемый текстом описания для таких элементов макета, как ImageItems , PageBreakItems SectionHeaderItems ).

Параметры

Имя Тип Описание
text String новый текст справки

Возвращаться

PageBreakItem — этот PageBreakItem для цепочки

Авторизация

Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

setTitle(title)

Устанавливает заголовок элемента (иногда называемый текстом заголовка, в случае SectionHeaderItem ).

Параметры

Имя Тип Описание
title String новый заголовок или текст заголовка

Возвращаться

PageBreakItem — этот PageBreakItem для цепочки

Авторизация

Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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