Esta página foi traduzida pela API Cloud Translation.

Class 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.
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 será direcionado depois de preencher a página anterior a esta quebra de página (ou seja, ao chegar a 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`	Extrai 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 que ocorre depois de concluir a página antes dessa quebra de página (ou seja, ao chegar a essa quebra de página por progressão linear normal pelo formulário).
`getTitle()`	`String`	Recebe o título do item (às vezes chamado de texto de cabeçalho, no caso de uma `SectionHeaderItem`).
`getType()`	`ItemType`	Recebe o tipo do item, representado como `ItemType`.
`setGoToPage(goToPageItem)`	`PageBreakItem`	Define a página de destino após a conclusão da página anterior à quebra de página (ou seja, chegar a essa página quebra por progressão linear normal pelo formulário).
`setGoToPage(navigationType)`	`PageBreakItem`	Define o tipo de navegação que ocorre após a conclusão da página antes dessa quebra de página (ou seja, ao chegar a essa quebra de página por 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 de cabeçalho, no caso de uma `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 precisam de 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 será direcionado depois de preencher a página anterior a esta quebra de página (ou seja, ao chegar a essa quebra de página por progressão linear normal pelo formulário).

Retornar

PageBreakItem: a quebra de página para acessar depois de concluir a página antes desta quebra de página, ou null se nenhuma estiver definida

Autorização

Os scripts que usam esse método precisam de 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 precisam de autorização com um ou mais dos seguintes escopos:

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

`getId()`

Extrai o identificador exclusivo do item.

Retornar

Integer: o código do item.

Autorização

Os scripts que usam esse método precisam de 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 precisam de 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 que ocorre depois de concluir a página antes dessa quebra de página (ou seja, ao chegar a essa quebra de página por progressão linear normal pelo formulário).

Retornar

PageNavigationType: a ação de navegação a ser realizada depois de concluir a página antes dessa quebra de página.

Autorização

Os scripts que usam esse método precisam de 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 uma SectionHeaderItem).

Retornar

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

Autorização

Os scripts que usam esse método precisam de 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 ItemType.

Retornar

ItemType: o tipo do item.

Autorização

Os scripts que usam esse método precisam de 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 de destino após a conclusão da página anterior à quebra de página (ou seja, chegar a essa página quebra por progressão linear normal pelo formulário). Se a página anterior continha um MultipleChoiceItem ou ListItem com uma opção de navegação, que a navegação se sobrepõe a essa navegação.

Parâmetros

Nome	Tipo	Descrição
`goToPageItem`	`PageBreakItem`	a quebra de página para a qual pular depois de completar a página antes desta quebra de página

Retornar

PageBreakItem: este PageBreakItem, para encadeamento

Autorização

Os scripts que usam esse método precisam de 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 que ocorre após a conclusão da página antes dessa quebra de página (ou seja, ao chegar a essa quebra de página por progressão linear normal pelo formulário). Se o página continha uma MultipleChoiceItem ou um ListItem com uma opção de navegação, que a navegação se sobrepõe a essa navegação.

Parâmetros

Nome	Tipo	Descrição
`navigationType`	`PageNavigationType`	a ação de navegação a ser realizada depois de preencher a página antes desta página quebrar

Retornar

PageBreakItem: este PageBreakItem, para encadeamento

Autorização

Os scripts que usam esse método precisam de 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 precisam de 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 uma 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 precisam de autorização com um ou mais dos seguintes escopos:

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