É um item de layout que marca o início de uma página. Os itens podem ser acessados ou criados a partir de 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 | Consiga o PageBreakItem para o qual o formulário pulará após a conclusão da página antes dessa
quebra de página (ou seja, ao alcançar essa quebra de página por progressão linear normal durante o
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 | Acessa o índice do item entre todos os itens no formulário. |
getPageNavigationType() | PageNavigationType | Recebe o tipo de navegação na página que ocorre após a conclusão da página antes dessa quebra de página, ou seja, ao atingir essa quebra de página por progressão linear normal usando o formulário. |
getTitle() | String | Recebe o título do item (às vezes chamado de texto de cabeçalho, no caso de um SectionHeaderItem ). |
getType() | ItemType | Recebe o tipo do item, representado como ItemType . |
setGoToPage(goToPageItem) | PageBreakItem | Define a página que deve ser pulada após a conclusão da página antes da quebra de página (ou seja, ao alcançar essa quebra de página por progressão linear normal usando o 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 dessa quebra de página, ou seja, ao atingir essa quebra de página com a progressão linear normal usando o 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 de 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
: 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()
Consiga o PageBreakItem
para o qual o formulário pulará após a conclusão da página antes dessa
quebra de página (ou seja, ao alcançar essa quebra de página por progressão linear normal durante o
formulário).
Retornar
PageBreakItem
: a quebra de página a ser exibida após a conclusão da página antes da quebra de página, ou null
se nenhuma página 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
).
Retornar
String
: o texto de ajuda ou 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()
Acessa 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
getTitle()
Recebe o título do item (às vezes chamado de texto de cabeçalho, no caso de um SectionHeaderItem
).
Retornar
String
: o 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 que deve ser pulada após a conclusão da página antes da quebra de página (ou seja, ao
alcançar essa quebra de página por progressão linear normal usando o formulário). Se a página anterior
contivesse um MultipleChoiceItem
ou ListItem
com uma opção de navegação, essa
navegação substituirá essa navegação.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
goToPageItem | PageBreakItem | a quebra de página para ver depois de concluir essa quebra de página |
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 de 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