Class PageBreakItem

Quebradepágina

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étodo	Tipo de retorno	Breve descrição
duplicate()	PageBreakItem	Cria uma cópia do item e a anexa ao final do formulário.
getGoToPage()	PageBreakItem	Extrai o PageBreakItem para o qual o formulário vai pular depois de preencher a página antes desse quebra de página (ou seja, ao chegar a esse ponto de quebra por progressão linear normal no formulário).
getHelpText()	String	Recebe o texto de ajuda do item (às vezes chamado de texto de descrição para itens de layout como ImageItems, PageBreakItems e SectionHeaderItems).
getId()	Integer	Recebe o identificador exclusivo do item.
getIndex()	Integer	Consegue o índice do item entre todos os itens no formulário.
getPageNavigationType()	PageNavigationType	Recebe o tipo de navegação de página que ocorre após a conclusão da página anterior a esse ponto de divisão (ou seja, ao chegar a esse ponto de divisão por progressão linear normal no formulário).
getTitle()	String	Extrai o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem).
getType()	ItemType	Recebe o tipo do item, representado como um ItemType.
setGoToPage(goToPageItem)	PageBreakItem	Define a página para pular depois de concluir a página anterior a essa quebra de página (ou seja, ao chegar a essa quebra de página pela progressão linear normal do formulário).
setGoToPage(navigationType)	PageBreakItem	Define o tipo de navegação de página que ocorre após a conclusão da página anterior a esse ponto de divisão (ou seja, ao chegar a esse ponto de divisão por progressão linear normal no formulário).
setHelpText(text)	PageBreakItem	Define 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)	PageBreakItem	Define 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 do item e a anexa ao final do formulário.

Retornar

PageBreakItem: uma cópia desta 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()

Extrai o PageBreakItem para o qual o formulário vai pular depois de preencher a página antes desse quebra de página (ou seja, ao chegar a esse ponto de quebra por progressão linear normal no formulário).

Retornar

PageBreakItem: a quebra de página para pular depois de concluir a página anterior a essa quebra 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()

Consegue o índice do item entre todos os itens no 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 de página que ocorre após a conclusão da página anterior a esse ponto de divisão (ou seja, ao chegar a esse ponto de divisão 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 antes da 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()

Extrai 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 pular depois de concluir a página anterior a essa quebra de página (ou seja, ao chegar a essa quebra de página pela progressão linear normal do 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 navegação.

Parâmetros

Nome	Tipo	Descrição
goToPageItem	PageBreakItem	a quebra de página para pular depois de concluir a página anterior

Retornar

PageBreakItem: este 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 de página que ocorre após a conclusão da página anterior a esse ponto de divisão (ou seja, ao chegar a esse ponto de divisão 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 navegação.

Parâmetros

Nome	Tipo	Descrição
navigationType	PageNavigationType	a ação de navegação a ser realizada após a conclusão da página antes da quebra

Retornar

PageBreakItem: este 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

Nome	Tipo	Descrição
text	String	o novo texto de ajuda

Retornar

PageBreakItem: este 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

Nome	Tipo	Descrição
title	String	o novo título ou texto do cabeçalho

Retornar

PageBreakItem: este 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