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. 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
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
duplicate() | PageBreakItem | Cria uma cópia desse item e a anexa ao final do formulário. |
getGoToPage() | PageBreakItem | Recebe o PageBreakItem para o qual o formulário pulará depois de concluir a página antes dessa
quebra de página, ou seja, ao alcançar essa quebra de página por progressão linear normal pelo
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 | Recebe o índice do item entre todos os itens do formulário. |
getPageNavigationType() | PageNavigationType | Recebe o tipo de navegação de página que ocorre após a conclusão da página antes da quebra de página, ou seja, ao chegar a essa quebra de página pela progressão linear normal pelo formulário. |
getTitle() | String | Recebe 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 de destino depois de concluí-la antes da quebra de página, ou seja, ao chegar a essa quebra de página por progressão linear normal pelo formulário. |
setGoToPage(navigationType) | PageBreakItem | Define o tipo de navegação na página que ocorre após a conclusão da página antes da quebra de página, ou seja, ao chegar a essa quebra de página pela progressão linear normal pelo 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 desse item e a anexa ao final do formulário.
Retorno
PageBreakItem
: uma cópia deste 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 pulará depois de concluir a página antes dessa
quebra de página, ou seja, ao alcançar essa quebra de página por progressão linear normal pelo
formulário.
Retorno
PageBreakItem
: a quebra de página a ser acessada depois de concluir a página antes dela ou null
se nenhuma delas tiver sido 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
).
Retorno
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.
Retorno
Integer
: 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.
Retorno
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
getTitle()
Recebe o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem
).
Retorno
String
: título ou 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()
setGoToPage(goToPageItem)
Define a página de destino depois de concluí-la antes da quebra de página, ou seja, ao
chegar a essa quebra de página por progressão linear normal pelo formulário. Se a página anterior
continha uma MultipleChoiceItem
ou ListItem
com uma opção de navegação, ela
vai substituir essa navegação.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
goToPageItem | PageBreakItem | a quebra de página a ser acessada depois de completar a página antes desta quebra de página |
Retorno
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 |
Retorno
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 |
Retorno
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