Class PageBreakItem

PageBreakItem

Élément de mise en page qui marque le début d'une page. Les éléments sont accessibles ou peuvent être créés à partir d'un 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éthodes

MéthodeType renvoyéBrève description
duplicate()PageBreakItemCrée une copie de cet élément et l'ajoute à la fin du formulaire.
getGoToPage()PageBreakItemObtient le PageBreakItem vers lequel le formulaire passera après avoir terminé la page avant ce saut de page (c'est-à-dire en atteignant ce saut de page par progression linéaire normale dans le formulaire).
getHelpText()StringObtient le texte d'aide de l'élément (parfois appelé texte de description pour les éléments de mise en page tels que ImageItems, PageBreakItems et SectionHeaderItems).
getId()IntegerObtient l'identifiant unique de l'élément.
getIndex()IntegerObtient l'index de l'élément parmi tous les éléments du formulaire.
getPageNavigationType()PageNavigationTypeObtient le type de navigation sur la page qui se produit après avoir terminé la page avant ce saut de page (c'est-à-dire en atteignant ce saut de page par progression linéaire normale dans le formulaire).
getTitle()StringObtient le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'un SectionHeaderItem).
getType()ItemTypeObtient le type de l'élément, représenté sous la forme d'un ItemType.
setGoToPage(goToPageItem)PageBreakItemDéfinit la page à laquelle passer une fois la page précédant ce saut de page terminée (c'est-à-dire lorsque ce saut de page est atteint en progressant de manière linéaire dans le formulaire).
setGoToPage(navigationType)PageBreakItemDéfinit le type de navigation sur la page qui se produit après avoir terminé la page avant ce saut de page (c'est-à-dire lorsque ce saut de page est atteint par progression linéaire normale dans le formulaire).
setHelpText(text)PageBreakItemDéfinit le texte d'aide de l'élément (parfois appelé texte de description pour les éléments de mise en page tels que ImageItems, PageBreakItems et SectionHeaderItems).
setTitle(title)PageBreakItemDéfinit le titre de l'élément (parfois appelé texte d'en-tête dans le cas d'un SectionHeaderItem).

Documentation détaillée

duplicate()

Crée une copie de cet élément et l'ajoute à la fin du formulaire.

Renvois

PageBreakItem : un double de ce PageBreakItem, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getGoToPage()

Obtient le PageBreakItem vers lequel le formulaire passera après avoir terminé la page avant ce saut de page (c'est-à-dire en atteignant ce saut de page par progression linéaire normale dans le formulaire).

Renvois

PageBreakItem : saut de page vers lequel passer après avoir terminé la page précédant ce saut de page, ou null si aucun n'est défini

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getHelpText()

Obtient le texte d'aide de l'élément (parfois appelé texte de description pour les éléments de mise en page tels que ImageItems, PageBreakItems et SectionHeaderItems).

Renvois

String : texte d'aide ou description de l'élément

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getId()

Obtient l'identifiant unique de l'élément.

Renvois

Integer : ID de l'article

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getIndex()

Obtient l'index de l'élément parmi tous les éléments du formulaire.

Renvois

Integer : index de l'élément

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getPageNavigationType()

Obtient le type de navigation sur la page qui se produit après avoir terminé la page avant ce saut de page (c'est-à-dire en atteignant ce saut de page par progression linéaire normale dans le formulaire).

Renvois

PageNavigationType : action de navigation à effectuer après avoir terminé la page avant ce saut de page

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getTitle()

Obtient le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'un SectionHeaderItem).

Renvois

String : titre ou texte d'en-tête de l'élément

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getType()

Obtient le type de l'élément, représenté sous la forme d'un ItemType.

Renvois

ItemType : type de l'élément

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

setGoToPage(goToPageItem)

Définit la page à laquelle passer une fois la page précédant ce saut de page terminée (c'est-à-dire lorsque ce saut de page est atteint en progressant de manière linéaire dans le formulaire). Si la page précédente contenait un MultipleChoiceItem ou un ListItem avec une option de navigation, cette navigation prévaut sur celle-ci.

Paramètres

NomTypeDescription
goToPageItemPageBreakItemle saut de page vers lequel passer après avoir terminé la page précédant ce saut de page.

Renvois

PageBreakItem : PageBreakItem, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

setGoToPage(navigationType)

Définit le type de navigation sur la page qui se produit après avoir terminé la page avant ce saut de page (c'est-à-dire lorsque ce saut de page est atteint par progression linéaire normale dans le formulaire). Si la page contenait un MultipleChoiceItem ou un ListItem avec une option de navigation, cette navigation prévaut sur celle-ci.

Paramètres

NomTypeDescription
navigationTypePageNavigationTypeAction de navigation à effectuer après avoir terminé la page avant celle-ci break

Renvois

PageBreakItem : PageBreakItem, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

setHelpText(text)

Définit le texte d'aide de l'élément (parfois appelé texte de description pour les éléments de mise en page tels que ImageItems, PageBreakItems et SectionHeaderItems).

Paramètres

NomTypeDescription
textStringle nouveau texte d'aide ;

Renvois

PageBreakItem : PageBreakItem, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

setTitle(title)

Définit le titre de l'élément (parfois appelé texte d'en-tête dans le cas d'un SectionHeaderItem).

Paramètres

NomTypeDescription
titleStringle nouveau titre ou texte d'en-tête.

Renvois

PageBreakItem : PageBreakItem, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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