Class PageBreakItem

PageBreakItem

Élément de mise en page qui marque le début d'une page. Vous pouvez accéder aux éléments ou en créer depuis une 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éthodes

MéthodeType renvoyéBrève description
duplicate()PageBreakItemCrée une copie de cet élément et l'ajoute à la fin du formulaire.
getGoToPage()PageBreakItemRécupère la PageBreakItem vers laquelle le formulaire va accéder après avoir terminé la page avant ce saut de page (c'est-à-dire lorsqu'il atteint ce saut de page par une progression linéaire normale dans le formulaire).
getHelpText()StringRécupère 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()IntegerRécupère l'identifiant unique de l'article.
getIndex()IntegerRécupère l'index de l'élément parmi tous les éléments du formulaire.
getPageNavigationType()PageNavigationTypeRécupère le type de navigation sur les pages qui se produit une fois la page terminée avant ce saut de page (c'est-à-dire, lorsqu'il atteint ce saut de page par une progression linéaire normale dans le formulaire).
getTitle()StringRécupère le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'une SectionHeaderItem).
getType()ItemTypeRécupère le type de l'élément, représenté par ItemType.
setGoToPage(goToPageItem)PageBreakItemDéfinit la page à laquelle accéder une fois la page terminée avant ce saut de page (c'est-à-dire, lorsque ce saut de page est atteint par une progression linéaire normale dans le formulaire).
setGoToPage(navigationType)PageBreakItemDéfinit le type de navigation sur les pages qui se produit une fois la page terminée avant ce saut de page (c'est-à-dire lorsqu'il atteint ce saut de page par une 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'une SectionHeaderItem).

Documentation détaillée

duplicate()

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

Renvois

PageBreakItem : doublon de ce PageBreakItem, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

getGoToPage()

Récupère la PageBreakItem vers laquelle le formulaire va accéder après avoir terminé la page avant ce saut de page (c'est-à-dire lorsqu'il atteint ce saut de page par une progression linéaire normale dans le formulaire).

Renvois

PageBreakItem : saut de page auquel accéder 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 associée à un ou plusieurs des champs d'application suivants:

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

getHelpText()

Récupère 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 associée à un ou plusieurs des champs d'application suivants:

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

getId()

Récupère l'identifiant unique de l'article.

Renvois

Integer : ID de l'élément

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

getIndex()

Récupère 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 associée à un ou plusieurs des champs d'application suivants:

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

getPageNavigationType()

Récupère le type de navigation sur les pages qui se produit une fois la page terminée avant ce saut de page (c'est-à-dire, lorsqu'il atteint ce saut de page par une progression linéaire normale dans le formulaire).

Renvois

PageNavigationType : action de navigation à effectuer une fois la page terminée avant ce saut de page

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

getTitle()

Récupère le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'une 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 associée à un ou plusieurs des champs d'application suivants:

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

getType()

Récupère le type de l'élément, représenté par ItemType.

Renvois

ItemType : type de l'élément

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

setGoToPage(goToPageItem)

Définit la page à laquelle accéder une fois la page terminée avant ce saut de page (c'est-à-dire, lorsque ce saut de page est atteint par une progression linéaire normale dans le formulaire). Si la page précédente contenait un élément MultipleChoiceItem ou ListItem avec une option de navigation, cette navigation la prévaut.

Paramètres

NomTypeDescription
goToPageItemPageBreakItemle saut de page auquel il faut accéder après avoir terminé la page précédant ce saut de page

Renvois

PageBreakItem : cette PageBreakItem, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

setGoToPage(navigationType)

Définit le type de navigation sur les pages qui se produit une fois la page terminée avant ce saut de page (c'est-à-dire lorsqu'il atteint ce saut de page par une progression linéaire normale dans le formulaire). Si la page contient un élément MultipleChoiceItem ou ListItem avec une option de navigation, cette navigation remplace celle-ci.

Paramètres

NomTypeDescription
navigationTypePageNavigationTypeAction de navigation à effectuer une fois la page terminée (avant le saut de page)

Renvois

PageBreakItem : cette PageBreakItem, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application 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 : cette PageBreakItem, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application 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'une SectionHeaderItem).

Paramètres

NomTypeDescription
titleStringle nouveau titre ou texte de l'en-tête

Renvois

PageBreakItem : cette PageBreakItem, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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