Class PageBreakItem

PageBreakItem

Um item de layout que marca o início de uma página. Os itens podem ser acessados ou criados em um 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

Métodos

MétodoTipo de retornoBreve descrição
duplicate()PageBreakItemCria uma cópia desse item e a anexa ao final do formulário.
getGoToPage()PageBreakItemRecebe o PageBreakItem para o qual o formulário vai pular depois de concluir a página anterior a essa quebra de página (ou seja, ao chegar a essa quebra de página por progressão linear normal no formulário).
getHelpText()StringRecebe o texto de ajuda do item (às vezes chamado de texto de descrição para itens de layout como ImageItems, PageBreakItems e SectionHeaderItems).
getId()IntegerRecebe o identificador exclusivo do item.
getIndex()IntegerRecebe o índice do item entre todos os itens do formulário.
getPageNavigationType()PageNavigationTypeRecebe o tipo de navegação nas páginas que ocorre após a conclusão da página anterior a essa quebra de página (ou seja, ao chegar a essa quebra de página por progressão linear normal no formulário).
getTitle()StringRecebe o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).
getType()ItemTypeRecebe o tipo do item, representado como um ItemType.
setGoToPage(goToPageItem)PageBreakItemDefine a página para a qual pular após a conclusão da página anterior a essa quebra de página (ou seja, ao chegar a essa quebra de página por progressão linear normal no formulário).
setGoToPage(navigationType)PageBreakItemDefine o tipo de navegação nas páginas que ocorre após a conclusão da página anterior a essa quebra de página (ou seja, ao chegar a essa quebra de página por progressão linear normal no formulário).
setHelpText(text)PageBreakItemDefine o texto de ajuda do item (às vezes chamado de texto de descrição para itens de layout como ImageItems, PageBreakItems, e SectionHeaderItems).
setTitle(title)PageBreakItemDefine o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).

Documentação detalhada

duplicate()

Cria uma cópia desse item e a anexa ao final do formulário.

Retornar

PageBreakItem — um duplicado desse PageBreakItem, para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getGoToPage()

Recebe o PageBreakItem para o qual o formulário vai pular depois de concluir a página anterior a essa quebra de página (ou seja, ao chegar a essa quebra de página por progressão linear normal no formulário).

Retornar

PageBreakItem — a quebra de página para pular após a conclusão da página anterior a essa quebra de página ou null se nenhuma estiver definida

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getHelpText()

Recebe o texto de ajuda do item (às vezes chamado de texto de descrição para itens de layout como ImageItems, PageBreakItems e SectionHeaderItems).

Retornar

String — o texto de ajuda ou de descrição do item

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getId()

Recebe o identificador exclusivo do item.

Retornar

Integer — o ID do item

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getIndex()

Recebe o índice do item entre todos os itens do formulário.

Retornar

Integer — o índice do item

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getPageNavigationType()

Recebe o tipo de navegação nas páginas que ocorre após a conclusão da página anterior a essa quebra de página (ou seja, ao chegar a essa quebra de página por progressão linear normal no formulário).

Retornar

PageNavigationType — a ação de navegação a ser realizada após a conclusão da página anterior a essa quebra de página

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getTitle()

Recebe o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).

Retornar

String — o título ou o texto do cabeçalho do item

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getType()

Recebe o tipo do item, representado como um ItemType.

Retornar

ItemType — o tipo do item

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

setGoToPage(goToPageItem)

Define a página para a qual pular após a conclusão da página anterior a essa quebra de página (ou seja, ao chegar a essa quebra de página por progressão linear normal no formulário). Se a página anterior contiver um MultipleChoiceItem ou ListItem com uma opção de navegação, essa navegação vai substituir essa.

Parâmetros

NomeTipoDescrição
goToPageItemPageBreakItema quebra de página para pular após a conclusão da página anterior a essa quebra de página

Retornar

PageBreakItem — esse PageBreakItem, para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

setGoToPage(navigationType)

Define o tipo de navegação nas páginas que ocorre após a conclusão da página anterior a essa quebra de página (ou seja, ao chegar a essa quebra de página por progressão linear normal no formulário). Se a página contiver um MultipleChoiceItem ou ListItem com uma opção de navegação, essa navegação vai substituir essa.

Parâmetros

NomeTipoDescrição
navigationTypePageNavigationTypea ação de navegação a ser realizada após a conclusão da página anterior a essa quebra de página

Retornar

PageBreakItem — esse PageBreakItem, para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

setHelpText(text)

Define o texto de ajuda do item (às vezes chamado de texto de descrição para itens de layout como ImageItems, PageBreakItems e SectionHeaderItems).

Parâmetros

NomeTipoDescrição
textStringo novo texto de ajuda

Retornar

PageBreakItem — esse PageBreakItem, para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

setTitle(title)

Define o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).

Parâmetros

NomeTipoDescrição
titleStringo novo título ou texto do cabeçalho

Retornar

PageBreakItem — esse PageBreakItem, para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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